Endpoints | Dagnam.AI Docs

Endpoints The main routes a personal API key can call, grouped by area. Unless a row says otherwise, every route below accepts a personal API key. Routes that only accept a web session account settings, profile editing, two factor authentication, sessions, data export, account deletion, and creating or revoking API keys themselves are not listed; manage those in Settings in the app instead. All paths are relative to /api/v1 unless noted. Projects Method Path Purpose --------- -------------------------------------- ---------------------------------------------------- POST /projects Create a project. GET /projects List your projects. GET /projects/ id Get a project. PUT /projects/ id Update a project. DELETE /projects/ id Delete a project. POST /projects/ id /duplicate Duplicate a project. POST /projects/bulk-delete Delete multiple projects. POST /projects/import-dag Import a project from a DAG file. POST /projects/ id /import-dag Import a DAG file into an existing project. GET, POST /projects/ id /thumbnail Get or upload a project's thumbnail. POST /projects/ id /share Create a share link. GET /projects/ id /shares List a project's share links. DELETE /projects/ id /shares/ share id Revoke a share link. POST, GET /projects/ id /datasets Link a dataset, or list a project's linked datasets. DELETE /projects/ id /datasets/ dataset id Unlink a dataset. GET /shared/ token Read a shared project no sign in required . POST /shared/ token /import Import a shared project into your account. Architecture versions Method Path Purpose ------ -------------------------------------- --------------------------------------------- POST /projects/ id /save Save the diagram and config as a new version. GET /projects/ id /versions List a project's architecture versions. GET /projects/ id /versions/compare Compare two versions. GET /projects/ id /versions/ version id Get one version. POST /projects/ id /restore/ version id Restore a version. DELETE /projects/ id /versions/ version id Delete a version. GET /projects/ id /latest Get the latest version. Code generation Method Path Purpose ------ --------------------------------------------- ------------------------------------------------------------------------------ POST /projects/ id /generate-code Generate code 200 with files, or 202 with a task id when ?async mode=true . GET /projects/ id /code-preview Preview generated code without saving. POST /projects/ id /validate Validate that a project can generate code. GET /projects/ id /code-status/ task id Poll an asynchronous generation task. POST /projects/ id /code-status/ task id /cancel Cancel an asynchronous generation task. GET /projects/ id /download-code Download generated code as a ZIP. Datasets Method Path Purpose ------ ------------------------------------------------------ ------------------------------------------------------------------------ POST /datasets/ Upload a dataset multipart; note the trailing slash . POST /datasets/from-url Start a server side GET /datasets/tasks/ task id Poll an GET /datasets/browse List and browse your datasets, including built-in ones. GET /datasets/ id Get a dataset. GET /datasets/ id /preview Preview a dataset's samples and statistics. PUT /datasets/ id Update a dataset. DELETE /datasets/ id Delete a dataset. PATCH /datasets/ id /roles Set column roles. GET /datasets/ id /meta Get dataset metadata, including a short-lived, single use download link. GET /datasets/ id /download Download a dataset, with your credential or a signed link from /meta . GET /datasets/ id /versions List a dataset's versions. GET /datasets/ id /versions/ version id Get one dataset version. POST /datasets/ id /versions/ version id /pii-scan Scan a dataset version for personal data. POST /datasets/ id /versions/ version id /splits/explicit Split a dataset version with explicit row membership. Training Method Path Purpose ------ ---------------------------------------------------------- -------------------------------------------------------- POST /training/jobs Create a training job. GET /training/jobs List your training jobs. GET /training/jobs/ id Get a training job. POST /training/jobs/ id /cancel Cancel a job. POST /training/jobs/ id /restart Restart a failed, cancelled or timed out job. POST /training/jobs/bulk-delete Delete 1 to 100 jobs. GET /training/jobs/ id /metrics Get historical metrics. GET /training/jobs/ id /metrics/summary Get aggregate metrics. GET /training/jobs/ id /logs Get historical logs. GET /training/jobs/ id /download-code Download the generated training code. GET /training/jobs/ id /dag Download the job's DAG JSON. POST /training/estimate-resources Estimate resources for a configuration. GET /training/allowed-strategies List the distribution strategies your account can use. GET /training/jobs/ id /checkpoints List a job's checkpoints. GET /training/jobs/ id /checkpoints/ checkpoint id /download Download a checkpoint. POST /training/jobs/ id /stream-access-token Mint a token for the training event stream. GET /streaming/training-jobs/ id /stream Stream a training job's events with a stream token . POST /training/jobs/ id /stream-token Mint an upload token for metrics from your own hardware. POST /training/jobs/ id /metrics/events Upload metric events from your own hardware. POST /training/foundation-runs Start a fine-tuning run. GET /training/foundation-runs/ id Get a fine-tuning run. POST /training/evaluations Start an evaluation. GET /training/evaluations/ id Get an evaluation. GET /foundation-catalog List curated base models available for fine-tuning. GET /training/recipes List the training recipes. Config ranges: epochs 1 to 1000, batch size 1 to 1024, learning rate above 0 and at most 1. Deployments Method Path Purpose ------ --------------------------------------- --------------------------------------------------------------------------------- POST /deployments/from-model-version Deploy a model version in one call; returns the deployment with its one-time key. GET /deployments List your deployments. GET /deployments/ id Get a deployment. PUT /deployments/ id Update a deployment. DELETE /deployments/ id Delete a deployment. POST /deployments/ id /rotate-key Rotate a deployment's key; the new key is shown once. POST /deployments/ id /pause Pause a deployment. POST /deployments/ id /resume Resume a deployment. GET /deployments/ id /health Get a deployment's health. GET /deployments/ id /metrics Get a deployment's metrics. GET /deployments/ id /logs Get a deployment's logs. POST /deployments/ id /stream-access-token Mint a token for the deployment event stream. GET /deployments/ id /stream Stream a deployment's events with a stream token . GET /deployments/ id /revisions List a deployment's revisions, newest first. Inference See Calling a deployment /docs/deployments/inference and OpenAI-compatible endpoint /docs/deployments/openai-compatible . Predict, batch, schema and health take the deployment key, not a personal API key. Starting a streaming prediction POST /inference/ id /predict/stream/session takes your personal API key or web session instead; see Streaming /docs/api/streaming inference-streaming . Hub Method Path Purpose ---------------- ------------------------------------------ --------------------------------------------------------------------------- GET /hub/models List hub models. GET /hub/models/search Search hub models. GET /hub/categories List hub categories. GET /hub/featured List featured models. GET /hub/trending List trending models. GET /hub/models/starred List models you have starred. POST /hub/models Create a hub model. GET, PUT, DELETE /hub/models/ id Get, update or delete a hub model. POST /hub/models/ id /finalize Finalize a hub model after uploading its files. POST /hub/models/ id /files Upload a file to a hub model. GET /hub/models/ id /files List a hub model's files. GET /hub/models/ id /files/ file id /content Download one file's content with the signed link from /download . POST /hub/models/ id /download Get a signed download link for a hub model, or one file. GET /hub/models/ id /download-all Download every file of a hub model with the signed link from /download . POST, DELETE /hub/models/ id /star Star or unstar a hub model. POST /hub/models/ id /fork Fork a hub model into your account. GET, POST /hub/models/ id /reviews List or add reviews. GET, POST /hub/models/ id /versions List or add versions. POST /hub/models/ id /use-in-studio Import a hub model into Studio as a new project. Model registry Method Path Purpose ------ ------------------------------------------------------- ------------------------------------------------------------------------------------ POST /models Create a model entry. GET /models List your model entries. GET /models/ id Get a model entry. PATCH /models/ id Update a model entry. DELETE /models/ id Delete a model entry. POST /models/ id /versions Push a new version. GET /models/ id /versions List a model entry's versions. GET /model-versions/ id Get a model version. GET /model-versions/ id /lineage Get a version's lineage graph. GET /model-versions/ id /evaluations Get a version's evaluation results. POST /model-versions/ id /artifacts:initiate Start an artifact upload; returns the URL, method and headers to send the file with. POST /model-versions/ id /artifacts/ artifact id /complete Mark an artifact upload complete. POST /model-versions/ id /finalize Finalize a version once its artifacts are uploaded. GET /model-versions/ id /artifacts List a version's artifacts. GET /model-versions/ id /artifacts/ artifact id /download Download one artifact. GET /task-contracts/ key /versions/ version Get a task contract definition. dagnam models push runs the create, version, artifact and finalize steps for you; see Python client /docs/dag-lib/python-client resource-modules . Audits Method Path Purpose ------------ ------------------------------------------------- ---------------------------------------------------------- GET /audits List your audits. GET /audits/ id Get an audit. GET /audits/ id /report Get an audit's report. POST, DELETE /audits/ id /share Create or revoke a share link. GET /audits/shared/ token Read a shared audit no sign in required . POST /audits/ id /workloads/ workload id /candidates Retrain a workload against a chosen recipe and base model. POST /audits/ id /cancel Cancel an audit's jobs and pause its deployments. DELETE /audits/ id Delete an audit and every artifact it created. Publishing an audit and recording its candidates and steps are what dagnam audit run calls as it works; see Workload audit /docs/dag-lib/workload-audit . Account Method Path Purpose ------ ------------------------------- ------------------------------------ GET /users/me/entitlements Get your plan's features and limits. GET /users/me/credits Get your credit balance. GET /users/me/api-keys/ id /usage Get one API key's usage. GET /datasets/storage/quota Get your storage quota and usage. GET /users/ username /profile Get a user's public profile. Health Method Path Purpose ------ --------- ---------------------------------------- GET /health Public health check outside /api/v1 .