TIDE REST API documentation

This page provides the main public entry points of the TIDE API together with command-line examples that can be reused in scripts, workflow managers, or external services.

---

Quick links

• Platform home
• REST API root
• OpenAPI schema
• List available services
• Data libraries JSON API
• Data libraries HTML page
• Recipe library JSON API
• Recipe library HTML page

---

Recommended workflow

1. Start with /rest/ or the OpenAPI schema to discover the public API.
2. Use /rest/services/ to list enabled services.
3. Inspect one service at /rest/services/{service_slug}/jobs/ to retrieve its submission schema.
4. Submit a job with POST /rest/services/{service_slug}/jobs/.
5. Monitor the job with /rest/jobs/{job_id}/status/ or /rest/jobs/{job_id}/status/stream/.

Example 1: list public services

curl -X GET "https://api.atgc-montpellier.fr/rest/services/"

Example 2: inspect a service schema

This returns the service description, categories, inputs, and accepted fields for submission.

curl -X GET "https://api.atgc-montpellier.fr/rest/services/phyml/jobs/"

Example 3: submit a BLAST job from the command line

This example uses a local FASTA query file and a server-side reference database exposed by TIDE.

curl -X POST "https://api.atgc-montpellier.fr/rest/services/blast/jobs/" \
  -H "X-ATGC-Submission-Source: cli-restapi" \
  -F "name=blast-demo" \
  -F "email=user@example.org" \
  -F "confirm_email=user@example.org" \
  -F "Query sequence file=@query.fasta" \
  -F "Database FASTA file=server://blast_databases/swissprot.fasta" \
  -F "Program=blastp"

Example 4: check job status

curl -X GET "https://api.atgc-montpellier.fr/rest/jobs/JOB_ID/status/"

Example 5: stream live status updates

curl -N -H "Accept: text/event-stream" \
  "https://api.atgc-montpellier.fr/rest/jobs/JOB_ID/status/stream/"

Example 6: verify an email token

Some submissions may require email verification before execution continues.

curl -X GET \
  "https://api.atgc-montpellier.fr/rest/email-verification/verify/?token=SIGNED_TOKEN"

Example 7: browse server-side data libraries

curl -X GET "https://api.atgc-montpellier.fr/rest/data-libraries/"

Example 8: browse downloadable recipes

curl -X GET "https://api.atgc-montpellier.fr/rest/recipes/"

Large files

For large uploads, TIDE also exposes a chunk-upload endpoint. Uploaded chunks can then be referenced during job submission through upload:// tokens.

curl -X PUT "https://api.atgc-montpellier.fr/rest/uploads/chunk/" \
  -H "Upload-Id: YOUR-UUID" \
  -H "X-File-Name: big_input.fasta" \
  -H "X-File-Size: TOTAL_BYTES" \
  -H "Content-Range: bytes START-END/TOTAL_BYTES" \
  --data-binary @chunk.bin

Notes

• File fields accept multipart uploads and, for selected services, server-side tokens such as server://....
• Some services also expose an HTML submission form at /rest/services/{service_slug}/jobs/form/.
• The OpenAPI schema is the best entry point for client generation and machine-readable integration.
• The API is suitable for manual CLI usage, shell scripts, and workflow automation.

Back to the TIDE overview page