{ "opencollection": "1.0.0", "info": { "name": "LangSmith", "version": "0.1.0" }, "items": [ { "info": { "name": "info", "type": "folder" }, "items": [ { "info": { "name": "Get Server Info", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/info" }, "docs": "Get information about the current deployment of LangSmith." }, { "info": { "name": "Get Health Info", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/info/health" }, "docs": "Get health information about the current deployment of LangSmith." } ] }, { "info": { "name": "metrics", "type": "folder" }, "items": [ { "info": { "name": "Get Queue Metrics", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metrics/queue/:queue_name", "params": [ { "name": "queue_name", "value": "", "type": "path" } ] }, "docs": "Return cached SAQ queue counts for the requested queue." } ] }, { "info": { "name": "tracer-sessions", "type": "folder" }, "items": [ { "info": { "name": "Get Tracing Project Prebuilt Dashboard", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/sessions/:session_id/dashboard", "headers": [ { "name": "accept", "value": "" } ], "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a prebuilt dashboard for a tracing project." }, { "info": { "name": "Read Tracer Session", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/sessions/:session_id", "headers": [ { "name": "accept", "value": "" } ], "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "include_stats", "value": "", "type": "query" }, { "name": "stats_start_time", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a specific session." }, { "info": { "name": "Update Tracer Session", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/sessions/:session_id", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a session." }, { "info": { "name": "Delete Tracer Session", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/sessions/:session_id", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a specific session." }, { "info": { "name": "Read Tracer Sessions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/sessions", "headers": [ { "name": "accept", "value": "" } ], "params": [ { "name": "reference_free", "value": "", "type": "query" }, { "name": "reference_dataset", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name_contains", "value": "", "type": "query" }, { "name": "dataset_version", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query" }, { "name": "sort_by_desc", "value": "", "type": "query" }, { "name": "metadata", "value": "", "type": "query" }, { "name": "sort_by_feedback_key", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "tag_value_id", "value": "", "type": "query" }, { "name": "facets", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "include_stats", "value": "", "type": "query" }, { "name": "use_approx_stats", "value": "", "type": "query" }, { "name": "stats_start_time", "value": "", "type": "query" }, { "name": "stats_select", "value": "", "type": "query" }, { "name": "stats_filter", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all sessions." }, { "info": { "name": "Create Tracer Session", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/sessions", "params": [ { "name": "upsert", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new session." }, { "info": { "name": "Delete Tracer Sessions", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/sessions", "params": [ { "name": "session_ids", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete sessions." }, { "info": { "name": "Read Tracer Sessions Runs Metadata", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/sessions/:session_id/metadata", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "metadata_keys", "value": "", "type": "query" }, { "name": "start_time", "value": "", "type": "query" }, { "name": "k", "value": "", "type": "query" }, { "name": "root_runs_only", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Given a session, a number K, and (optionally) a list of metadata keys, return the top K values for each key." }, { "info": { "name": "Read Filter Views", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/sessions/:session_id/views", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all filter views for a session." }, { "info": { "name": "Create Filter View", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/sessions/:session_id/views", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new filter view." }, { "info": { "name": "Read Filter View", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/sessions/:session_id/views/:view_id", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "view_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a specific filter view." }, { "info": { "name": "Update Filter View", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/sessions/:session_id/views/:view_id", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "view_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a filter view." }, { "info": { "name": "Delete Filter View", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/sessions/:session_id/views/:view_id", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "view_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a specific filter view." }, { "info": { "name": "Rename Filter View", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/sessions/:session_id/views/:view_id/rename", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "view_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Rename a filter view (display_name and description only)." }, { "info": { "name": "[Beta] Get Insights Jobs", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/sessions/:session_id/insights", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "config_id", "value": "", "type": "query" }, { "name": "legacy", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all clusters for a session." }, { "info": { "name": "[Beta] Create Insights Job", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/sessions/:session_id/insights", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create an insights job." }, { "info": { "name": "[Beta] Get Insights Job Configs", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/sessions/:session_id/insights/configs", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "include_prebuilts", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all insights job configs for a session." }, { "info": { "name": "[Beta] Create Insights Job Config", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/sessions/:session_id/insights/configs", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Save an insights job config." }, { "info": { "name": "[Beta] Auto-Generate Insights Job Config", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/sessions/:session_id/insights/configs/generate", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Auto-generate an insights job config." }, { "info": { "name": "[Beta] Update Insights Job Config", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/sessions/:session_id/insights/configs/:config_id", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "config_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update an insights job config." }, { "info": { "name": "[Beta] Delete Insights Job Config", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/sessions/:session_id/insights/configs/:config_id", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "config_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete an insights job config." }, { "info": { "name": "[Beta] Get Insights Job", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/sessions/:session_id/insights/:job_id", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "job_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a specific cluster job for a session." }, { "info": { "name": "[Beta] Update Insights Job", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/sessions/:session_id/insights/:job_id", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "job_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a session cluster job." }, { "info": { "name": "[Beta] Delete Insights Job", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/sessions/:session_id/insights/:job_id", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "job_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a session cluster job." }, { "info": { "name": "[Beta] Get Run Cluster From Insights Job", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/sessions/:session_id/insights/:job_id/clusters/:cluster_id", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "job_id", "value": "", "type": "path" }, { "name": "cluster_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a specific cluster for a session." }, { "info": { "name": "[Beta] Get Runs From Insights Job", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/sessions/:session_id/insights/:job_id/runs", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "job_id", "value": "", "type": "path" }, { "name": "cluster_id", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "attribute_sort_key", "value": "", "type": "query" }, { "name": "attribute_sort_order", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all runs for a cluster job, optionally filtered by cluster." } ] }, { "info": { "name": "workspaces", "type": "folder" }, "items": [ { "info": { "name": "List Workspaces", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces", "params": [ { "name": "include_deleted", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all workspaces visible to this auth in the current org. Does not create a new workspace/org." }, { "info": { "name": "Create Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/workspaces", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new workspace." }, { "info": { "name": "Patch Workspace", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/workspaces/:workspace_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a workspace." }, { "info": { "name": "Delete Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/workspaces/:workspace_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete Workspace" }, { "info": { "name": "Get Current Workspace Stats", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/stats", "params": [ { "name": "tag_value_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Current Workspace Stats" }, { "info": { "name": "Get Current Workspace Usage Limits Info", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/usage_limits", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Current Workspace Usage Limits Info" }, { "info": { "name": "Get Shared Tokens", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/shared", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List all shared entities and their tokens by the workspace." }, { "info": { "name": "Bulk Unshare Entities", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/workspaces/current/shared", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Bulk unshare entities by share tokens for the workspace." }, { "info": { "name": "List Current Workspace Secrets", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/secrets", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List Current Workspace Secrets" }, { "info": { "name": "Upsert Current Workspace Secrets", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/workspaces/current/secrets", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Upsert Current Workspace Secrets" }, { "info": { "name": "Get Current Workspace Encrypted Secrets", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/secrets/encrypted", "params": [ { "name": "service", "value": "", "type": "query", "description": "Service requesting encrypted secrets" }, { "name": "key_names", "value": "", "type": "query", "description": "Optional list of workspace secret keys to return" }, { "name": "expand_iam_role", "value": "", "type": "query", "description": "If true, expand AWS_IAM_ROLE_ARN into temporary credentials via STS" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get encrypted workspace secrets for use with Fleet and external services." }, { "info": { "name": "List Tag Keys", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/tag-keys", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List Tag Keys" }, { "info": { "name": "Create Tag Key", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/workspaces/current/tag-keys", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create Tag Key" }, { "info": { "name": "Get Tag Key", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/tag-keys/:tag_key_id", "params": [ { "name": "tag_key_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Tag Key" }, { "info": { "name": "Update Tag Key", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/workspaces/current/tag-keys/:tag_key_id", "params": [ { "name": "tag_key_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update Tag Key" }, { "info": { "name": "Delete Tag Key", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/workspaces/current/tag-keys/:tag_key_id", "params": [ { "name": "tag_key_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete Tag Key" }, { "info": { "name": "List Tag Values", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/tag-keys/:tag_key_id/tag-values", "params": [ { "name": "tag_key_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List Tag Values" }, { "info": { "name": "Create Tag Value", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/workspaces/current/tag-keys/:tag_key_id/tag-values", "params": [ { "name": "tag_key_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create Tag Value" }, { "info": { "name": "Get Tag Value", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/tag-keys/:tag_key_id/tag-values/:tag_value_id", "params": [ { "name": "tag_key_id", "value": "", "type": "path" }, { "name": "tag_value_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Tag Value" }, { "info": { "name": "Update Tag Value", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/workspaces/current/tag-keys/:tag_key_id/tag-values/:tag_value_id", "params": [ { "name": "tag_key_id", "value": "", "type": "path" }, { "name": "tag_value_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update Tag Value" }, { "info": { "name": "Delete Tag Value", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/workspaces/current/tag-keys/:tag_key_id/tag-values/:tag_value_id", "params": [ { "name": "tag_key_id", "value": "", "type": "path" }, { "name": "tag_value_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete Tag Value" }, { "info": { "name": "List Taggings", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/taggings", "params": [ { "name": "tag_value_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List Taggings" }, { "info": { "name": "Create Tagging", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/workspaces/current/taggings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create Tagging" }, { "info": { "name": "Delete Tagging", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/workspaces/current/taggings/:tagging_id", "params": [ { "name": "tagging_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete Tagging" }, { "info": { "name": "List Tags", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/tags", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List Tags" }, { "info": { "name": "List Tags For Resource", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/tags/resource", "params": [ { "name": "resource_type", "value": "", "type": "query" }, { "name": "resource_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List Tags For Resource" }, { "info": { "name": "List Tags For Resources", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/workspaces/current/tags/resources", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List Tags For Resources" }, { "info": { "name": "List Pending Workspace Invites", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/pending", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all workspaces visible to this auth" }, { "info": { "name": "Delete Pending Workspace Invite", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/workspaces/pending/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Pending Workspace Invite" }, { "info": { "name": "Claim Pending Workspace Invite", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/workspaces/pending/:workspace_id/claim", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Claim Pending Workspace Invite" }, { "info": { "name": "Get Current Workspace Members", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/members", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Current Workspace Members" }, { "info": { "name": "Add Member To Current Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/workspaces/current/members", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Add an existing organization member to the current workspace." }, { "info": { "name": "Get Current Active Workspace Members", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/members/active", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "emails", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search query for email or name" }, { "name": "sort_by_desc", "value": "", "type": "query", "description": "Sort in descending order" }, { "name": "ls_user_ids", "value": "", "type": "query" }, { "name": "user_ids", "value": "", "type": "query" }, { "name": "is_disabled", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query", "description": "Field to sort by" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Current Active Workspace Members" }, { "info": { "name": "Get Current Pending Workspace Members", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/workspaces/current/members/pending", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "emails", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search query for email or name" }, { "name": "sort_by_desc", "value": "", "type": "query", "description": "Sort in descending order" }, { "name": "sort_by", "value": "", "type": "query", "description": "Field to sort by" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Current Pending Workspace Members" }, { "info": { "name": "Add Members To Current Workspace Batch", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/workspaces/current/members/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Batch invite up to 500 users to the current workspace and organization." }, { "info": { "name": "Patch Current Workspace Member", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/workspaces/current/members/:identity_id", "params": [ { "name": "identity_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Patch Current Workspace Member" }, { "info": { "name": "Delete Current Workspace Member", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/workspaces/current/members/:identity_id", "params": [ { "name": "identity_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete Current Workspace Member" }, { "info": { "name": "Delete Current Workspace Pending Member", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/workspaces/current/members/:identity_id/pending", "params": [ { "name": "identity_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete Current Workspace Pending Member" } ] }, { "info": { "name": "audit-logs", "type": "folder" }, "items": [ { "info": { "name": "Get Audit Logs", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/audit-logs", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of items to return" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor for pagination (base64-encoded JSON string)" }, { "name": "workspace_id", "value": "", "type": "query", "description": "Filter by workspace ID" }, { "name": "start_time", "value": "", "type": "query", "description": "Start datetime (inclusive) in ISO 8601 format" }, { "name": "end_time", "value": "", "type": "query", "description": "End datetime (inclusive) in ISO 8601 format" }, { "name": "operations", "value": "", "type": "query", "description": "Filter by operation names. If omitted, all operations are returned." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Retrieve audit log records for the authenticated user's organization in OCSF format.\n\nRequires both start_time and end_time parameters to filter logs within a date range.\nSupports cursor-based pagination.\n\nReturns results in OCSF API Activity (Class UID: 6003) format,\nwhich is compatible with security monitoring and SIEM tools.\nReference: https://schema.ocsf.io/1.7.0/classes/api_activity" } ] }, { "info": { "name": "ttl-settings", "type": "folder" }, "items": [ { "info": { "name": "List Ttl Settings", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/ttl-settings", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List out the configured TTL settings for a given tenant." }, { "info": { "name": "Upsert Ttl Settings", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/ttl-settings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Upsert Ttl Settings" } ] }, { "info": { "name": "orgs", "type": "folder" }, "items": [ { "info": { "name": "List Ttl Settings", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/ttl-settings", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List out the configured TTL settings for a given org (org-level and tenant-level)." }, { "info": { "name": "Upsert Ttl Settings", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/orgs/ttl-settings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Upsert Ttl Settings" }, { "info": { "name": "List Organizations", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs", "params": [ { "name": "skip_create", "value": "", "type": "query" }, { "name": "include_tier", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all orgs visible to this auth" }, { "info": { "name": "Create Organization", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Organization" }, { "info": { "name": "Create Customers And Get Stripe Setup Intent", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/setup", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create Customers And Get Stripe Setup Intent" }, { "info": { "name": "Get Organization Info", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Organization Info" }, { "info": { "name": "Get Current Organization Info", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/info", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Current Organization Info" }, { "info": { "name": "Update Current Organization Info", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/orgs/current/info", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update Current Organization Info" }, { "info": { "name": "Get Organization Billing Info", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/billing", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Organization Billing Info" }, { "info": { "name": "Get Dashboard", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/dashboard", "params": [ { "name": "type", "value": "", "type": "query" }, { "name": "color_scheme", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Dashboard" }, { "info": { "name": "On Payment Method Created", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/payment-method", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "On Payment Method Created" }, { "info": { "name": "Get Company Info", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/business-info", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Company Info" }, { "info": { "name": "Set Company Info", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/business-info", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Set Company Info" }, { "info": { "name": "Change Payment Plan", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/plan", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Change Payment Plan" }, { "info": { "name": "List Organization Roles", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/roles", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List Organization Roles" }, { "info": { "name": "Create Organization Roles", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/roles", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create Organization Roles" }, { "info": { "name": "Update Organization Roles", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/orgs/current/roles/:role_id", "params": [ { "name": "role_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update Organization Roles" }, { "info": { "name": "Delete Organization Roles", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/orgs/current/roles/:role_id", "params": [ { "name": "role_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete Organization Roles" }, { "info": { "name": "List Permissions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/permissions", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Permissions" }, { "info": { "name": "List Pending Organization Invites", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/pending", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all pending orgs visible to this auth" }, { "info": { "name": "Get Current Org Members", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/members", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Current Org Members" }, { "info": { "name": "Add Member To Current Org", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/members", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Add Member To Current Org" }, { "info": { "name": "Get Current Active Org Members", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/members/active", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "emails", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search query for email or name" }, { "name": "sort_by_desc", "value": "", "type": "query", "description": "Sort in descending order" }, { "name": "ls_user_ids", "value": "", "type": "query" }, { "name": "user_ids", "value": "", "type": "query" }, { "name": "is_disabled", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query", "description": "Field to sort by" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Current Active Org Members" }, { "info": { "name": "Get Current Pending Org Members", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/members/pending", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "emails", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search query for email or name" }, { "name": "sort_by_desc", "value": "", "type": "query", "description": "Sort in descending order" }, { "name": "sort_by", "value": "", "type": "query", "description": "Field to sort by" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Current Pending Org Members" }, { "info": { "name": "Add Members To Current Org Batch", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/members/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Batch invite up to 500 users to the current org." }, { "info": { "name": "Add Basic Auth Members To Current Org", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/members/basic/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Batch add up to 500 users to the org and specified workspaces in basic auth mode." }, { "info": { "name": "Delete Current Org Pending Member", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/orgs/current/members/:identity_id/pending", "params": [ { "name": "identity_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "When an admin deletes a pending member invite." }, { "info": { "name": "Delete Pending Organization Invite", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/orgs/pending/:organization_id", "params": [ { "name": "organization_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Pending Organization Invite" }, { "info": { "name": "Claim Pending Organization Invite", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/pending/:organization_id/claim", "params": [ { "name": "organization_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Claim Pending Organization Invite" }, { "info": { "name": "Update Current Org Member", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/orgs/current/members/:identity_id", "params": [ { "name": "identity_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "This is used for updating a user's role (all auth modes) or full_name/password (basic auth)" }, { "info": { "name": "Remove Member From Current Org", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/orgs/current/members/:identity_id", "params": [ { "name": "identity_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Remove a user from the current organization." }, { "info": { "name": "Update Current User", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/orgs/members/basic", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a user's full_name/password (basic auth only)" }, { "info": { "name": "Get Current Sso Settings", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/sso-settings", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get SSO provider settings for the current organization." }, { "info": { "name": "Create Sso Settings", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/sso-settings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create SSO provider settings for the current organization." }, { "info": { "name": "Update Sso Settings", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/orgs/current/sso-settings/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update SSO provider settings defaults for the current organization." }, { "info": { "name": "Delete Sso Settings", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/orgs/current/sso-settings/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete SSO provider settings for the current organization." }, { "info": { "name": "Update Allowed Login Methods", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/orgs/current/login-methods", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update allowed login methods for the current organization." }, { "info": { "name": "Get Org Usage", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/billing/usage", "params": [ { "name": "starting_on", "value": "", "type": "query" }, { "name": "ending_before", "value": "", "type": "query" }, { "name": "on_current_plan", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Org Usage" }, { "info": { "name": "Get Granular Usage", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/billing/granular-usage", "params": [ { "name": "start_time", "value": "", "type": "query" }, { "name": "end_time", "value": "", "type": "query" }, { "name": "workspace_ids", "value": "", "type": "query" }, { "name": "group_by", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get granular usage data with flexible grouping.\n\nworkspace_ids filters results to the specified workspaces. Only workspaces\nthe user has read access to will be included in the results." }, { "info": { "name": "Export Granular Usage Csv", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/billing/granular-usage/export", "params": [ { "name": "start_time", "value": "", "type": "query" }, { "name": "end_time", "value": "", "type": "query" }, { "name": "workspace_ids", "value": "", "type": "query" }, { "name": "group_by", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Export granular usage data as CSV.\n\nReturns the same data as the granular-usage endpoint but formatted as a\ndownloadable CSV file. Only workspaces the user has read access to will\nbe included in the results." }, { "info": { "name": "Get Current User Login Methods", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/user/login-methods", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get login methods for the current user." }, { "info": { "name": "Create Stripe Checkout Sessions Endpoint", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/stripe_checkout_session", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Kick off a Stripe checkout session flow." }, { "info": { "name": "Create Stripe Account Links Endpoint", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/stripe_account_links", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Kick off a Stripe account link flow." }, { "info": { "name": "List Org Service Keys", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/service-keys", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List Org Service Keys" }, { "info": { "name": "Create Org Service Key", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/service-keys", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create org-scoped service key. If workspaces is None, key is org-wide." }, { "info": { "name": "Delete Org Service Key", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/orgs/current/service-keys/:api_key_id", "params": [ { "name": "api_key_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete Org Service Key" }, { "info": { "name": "List Org Personal Access Tokens", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/orgs/current/personal-access-tokens", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List Org Personal Access Tokens" }, { "info": { "name": "Create Org Personal Access Token", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/personal-access-tokens", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create Org Personal Access Token" }, { "info": { "name": "Delete Org Personal Access Token", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/orgs/current/personal-access-tokens/:pat_id", "params": [ { "name": "pat_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete Org Personal Access Token" }, { "info": { "name": "Set Default Sso Provision", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/orgs/current/set-default-sso-provision", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Set the current organization as the default for SSO provisioning in self-hosted environments." }, { "info": { "name": "List org members with workspace roles", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/orgs/current/members", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Page size (default 50, max 500)" }, { "name": "offset", "value": "", "type": "query", "description": "Page offset (default 0)" }, { "name": "active_is", "value": "", "type": "query", "description": "Filter: true = only active members; false = only pending members" }, { "name": "pending_is", "value": "", "type": "query", "description": "Filter: true = only pending members; false = only active members" }, { "name": "name_like", "value": "", "type": "query", "description": "Glob filter on display name; use * as wildcard (repeatable, matches any)" }, { "name": "email_like", "value": "", "type": "query", "description": "Glob filter on email; use * as wildcard (repeatable, matches any)" }, { "name": "workspace_name_like", "value": "", "type": "query", "description": "Glob filter on workspace name or ID; use * as wildcard (repeatable, matches any)" }, { "name": "organization_role_like", "value": "", "type": "query", "description": "Glob filter on organization role name; use * as wildcard (repeatable, matches any)" }, { "name": "workspace_role_like", "value": "", "type": "query", "description": "Glob filter on workspace role name; use * as wildcard (repeatable, matches any)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns a paginated list of org members (active and pending) enriched with workspace memberships." } ] }, { "info": { "name": "examples", "type": "folder" }, "items": [ { "info": { "name": "Count Examples", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/examples/count", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "as_of", "value": "", "type": "query", "description": "Only modifications made on or before this time are included. If None, the latest version of the dataset is used." }, { "name": "metadata", "value": "", "type": "query" }, { "name": "full_text_contains", "value": "", "type": "query" }, { "name": "splits", "value": "", "type": "query" }, { "name": "dataset", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Count all examples by query params" }, { "info": { "name": "Read Example", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/examples/:example_id", "params": [ { "name": "example_id", "value": "", "type": "path" }, { "name": "as_of", "value": "", "type": "query", "description": "Only modifications made on or before this time are included. If None, the latest version of the dataset is used." }, { "name": "dataset", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a specific example." }, { "info": { "name": "Update Example", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/examples/:example_id", "params": [ { "name": "example_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a specific example." }, { "info": { "name": "Delete Example", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/examples/:example_id", "params": [ { "name": "example_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Soft delete an example. Only deletes the example in the 'latest' version of the dataset." }, { "info": { "name": "Read Examples", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/examples", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "as_of", "value": "", "type": "query", "description": "Only modifications made on or before this time are included. If None, the latest version of the dataset is used." }, { "name": "metadata", "value": "", "type": "query" }, { "name": "full_text_contains", "value": "", "type": "query" }, { "name": "splits", "value": "", "type": "query" }, { "name": "dataset", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "random_seed", "value": "", "type": "query" }, { "name": "select", "value": "", "type": "query" }, { "name": "descending", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all examples by query params" }, { "info": { "name": "Create Example", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/examples", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new example." }, { "info": { "name": "Delete Examples", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/examples", "params": [ { "name": "example_ids", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Soft delete examples. Only deletes the examples in the 'latest' version of the dataset." }, { "info": { "name": "Create Examples", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/examples/bulk", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create bulk examples." }, { "info": { "name": "Legacy Update Examples", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/examples/bulk", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Legacy update examples in bulk. For update involving attachments, use PATCH /v1/platform/datasets/{dataset_id}/examples instead." }, { "info": { "name": "Upload Examples From Csv", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/examples/upload/:dataset_id", "params": [ { "name": "dataset_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Upload examples from a CSV file.\n\nNote: For non-csv upload, please use\nthe POST /v1/platform/datasets/{dataset_id}/examples endpoint which provides more efficient upload." }, { "info": { "name": "Validate Example", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/examples/validate", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Validate an example." }, { "info": { "name": "Validate Examples", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/examples/validate/bulk", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Validate examples in bulk." }, { "info": { "name": "Hard Delete Examples", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/datasets/examples/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "This endpoint hard deletes *all* versions of a dataset example(s).\nDeletion is performed by setting inputs, outputs, and metadata to null and deleting attachment files while keeping the example ID, dataset ID, and creation timestamp.\nIMPORTANT: attachment files can take up to 7 days to be deleted. inputs, outputs and metadata are nullified immediately." }, { "info": { "name": "Upload Examples", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/datasets/:dataset_id/examples", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset ID" } ], "body": { "type": "multipart-form", "data": [ { "name": "{example_id}", "type": "text", "value": "" }, { "name": "{example_id}.inputs", "type": "text", "value": "" }, { "name": "{example_id}.outputs", "type": "text", "value": "" }, { "name": "{example_id}.attachments.{name}", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "This endpoint allows clients to upload examples to a specified dataset by sending a multipart/form-data POST request.\nEach form part contains either JSON-encoded data or binary attachment files associated with an example." }, { "info": { "name": "Update Examples", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/platform/datasets/:dataset_id/examples", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset ID" } ], "body": { "type": "multipart-form", "data": [ { "name": "{example_id}", "type": "text", "value": "" }, { "name": "{example_id}.inputs", "type": "text", "value": "" }, { "name": "{example_id}.outputs", "type": "text", "value": "" }, { "name": "{example_id}.attachments_operations", "type": "text", "value": "" }, { "name": "{example_id}.attachment.{name}", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "This endpoint allows clients to update existing examples in a specified dataset by sending a multipart/form-data PATCH request.\nEach form part contains either JSON-encoded data or binary attachment files to update an example." } ] }, { "info": { "name": "datasets", "type": "folder" }, "items": [ { "info": { "name": "Read Datasets", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/datasets", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "data_type", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name_contains", "value": "", "type": "query" }, { "name": "metadata", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query" }, { "name": "sort_by_desc", "value": "", "type": "query" }, { "name": "tag_value_id", "value": "", "type": "query" }, { "name": "exclude_corrections_datasets", "value": "", "type": "query" }, { "name": "exclude", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all datasets by query params and owner." }, { "info": { "name": "Create Dataset", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new dataset." }, { "info": { "name": "Delete Datasets", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/datasets", "params": [ { "name": "dataset_ids", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete multiple datasets." }, { "info": { "name": "Read Datasets Stream", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/datasets/stream", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "data_type", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name_contains", "value": "", "type": "query" }, { "name": "metadata", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query" }, { "name": "sort_by_desc", "value": "", "type": "query" }, { "name": "tag_value_id", "value": "", "type": "query" }, { "name": "exclude_corrections_datasets", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Stream all datasets by query params and owner as JSON patches." }, { "info": { "name": "Read Dataset", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/datasets/:dataset_id", "params": [ { "name": "dataset_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a specific dataset." }, { "info": { "name": "Update Dataset", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/datasets/:dataset_id", "params": [ { "name": "dataset_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a specific dataset." }, { "info": { "name": "Delete Dataset", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/datasets/:dataset_id", "params": [ { "name": "dataset_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a specific dataset." }, { "info": { "name": "Upload Csv Dataset", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets/upload", "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new dataset from a CSV or JSONL file." }, { "info": { "name": "Upload Experiment", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets/upload-experiment", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Upload an experiment that has already been run." }, { "info": { "name": "Get Dataset Versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/datasets/:dataset_id/versions", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "search", "value": "", "type": "query" }, { "name": "example", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get dataset versions." }, { "info": { "name": "Diff Dataset Versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/datasets/:dataset_id/versions/diff", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "from_version", "value": "", "type": "query" }, { "name": "to_version", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get diff between two dataset versions." }, { "info": { "name": "Get Dataset Version", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/datasets/:dataset_id/version", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "as_of", "value": "", "type": "query" }, { "name": "tag", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get dataset version by as_of or exact tag." }, { "info": { "name": "Update Dataset Version", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/datasets/:dataset_id/tags", "params": [ { "name": "dataset_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Set a tag on a dataset version." }, { "info": { "name": "Download Dataset Openai", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/datasets/:dataset_id/openai", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "as_of", "value": "", "type": "query", "description": "Only modifications made on or before this time are included. If None, the latest version of the dataset is used." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Download a dataset as OpenAI Evals Jsonl format." }, { "info": { "name": "Download Dataset Openai Ft", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/datasets/:dataset_id/openai_ft", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "as_of", "value": "", "type": "query", "description": "Only modifications made on or before this time are included. If None, the latest version of the dataset is used." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Download a dataset as OpenAI Jsonl format." }, { "info": { "name": "Download Dataset Csv", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/datasets/:dataset_id/csv", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "as_of", "value": "", "type": "query", "description": "Only modifications made on or before this time are included. If None, the latest version of the dataset is used." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Download a dataset as CSV format." }, { "info": { "name": "Download Dataset Jsonl", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/datasets/:dataset_id/jsonl", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "as_of", "value": "", "type": "query", "description": "Only modifications made on or before this time are included. If None, the latest version of the dataset is used." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Download a dataset as CSV format." }, { "info": { "name": "Read Examples With Runs", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets/:dataset_id/runs", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "format", "value": "", "type": "query", "description": "Response format, e.g., 'csv'" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Fetch examples for a dataset, and fetch the runs for each example if they are associated with the given session_ids." }, { "info": { "name": "Read Examples With Runs Grouped", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets/:dataset_id/group/runs", "params": [ { "name": "dataset_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Fetch examples for a dataset, and fetch the runs for each example if they are associated with the given session_ids." }, { "info": { "name": "Read Delta", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets/:dataset_id/runs/delta", "params": [ { "name": "dataset_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Fetch the number of regressions/improvements for each example in a dataset, between sessions[0] and sessions[1]." }, { "info": { "name": "Read Delta Stream", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets/:dataset_id/runs/delta/stream", "params": [ { "name": "dataset_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Stream feedback deltas for multiple feedback keys.\n\nReturns results in chunks as they become available. Each chunk contains\nresults for one or more feedback keys. Errors for individual chunks are\nincluded in the response rather than failing the entire operation.\n\nResponse format (SSE):\n event: data\n data: {\"feedback_deltas\": {\"key1\": {session_id: {...}}, ...}, \"errors\": null}\n\n event: data\n data: {\"feedback_deltas\": {\"key2\": {...}}, \"errors\": null}\n\n event: end" }, { "info": { "name": "Read Grouped Experiments", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets/:dataset_id/experiments/grouped", "params": [ { "name": "dataset_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Stream grouped and aggregated experiments." }, { "info": { "name": "Read Dataset Share State", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/datasets/:dataset_id/share", "params": [ { "name": "dataset_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get the state of sharing a dataset" }, { "info": { "name": "Share Dataset", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/datasets/:dataset_id/share", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "share_projects", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Share a dataset." }, { "info": { "name": "Unshare Dataset", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/datasets/:dataset_id/share", "params": [ { "name": "dataset_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Unshare a dataset." }, { "info": { "name": "Read Comparative Experiments", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/datasets/:dataset_id/comparative", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" }, { "name": "name_contains", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query" }, { "name": "sort_by_desc", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all comparative experiments for a given dataset." }, { "info": { "name": "Create Comparative Experiment", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets/comparative", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a comparative experiment." }, { "info": { "name": "Delete Comparative Experiment", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/datasets/comparative/:comparative_experiment_id", "params": [ { "name": "comparative_experiment_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a specific comparative experiment." }, { "info": { "name": "Clone Dataset", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets/clone", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Clone a dataset." }, { "info": { "name": "Get Dataset Splits", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/datasets/:dataset_id/splits", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "as_of", "value": "", "type": "query", "description": "Only modifications made on or before this time are included. If None, the latest version of the dataset is used." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Dataset Splits" }, { "info": { "name": "Update Dataset Splits", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/datasets/:dataset_id/splits", "params": [ { "name": "dataset_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update Dataset Splits" }, { "info": { "name": "Generate", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets/:dataset_id/generate", "params": [ { "name": "dataset_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Generate synthetic examples for a dataset." }, { "info": { "name": "Dataset Handler", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets/playground_experiment/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Dataset Handler" }, { "info": { "name": "Stream Dataset Handler", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets/playground_experiment/stream", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Stream Dataset Handler" }, { "info": { "name": "Studio Experiment", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/datasets/studio_experiment", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Studio Experiment" } ] }, { "info": { "name": "run", "type": "folder" }, "items": [ { "info": { "name": "List Rules", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/runs/rules", "params": [ { "name": "dataset_id", "value": "", "type": "query" }, { "name": "session_id", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "name_contains", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "evaluator_id", "value": "", "type": "query" }, { "name": "tag_value_id", "value": "", "type": "query" }, { "name": "include_backfill_progress", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List all run rules." }, { "info": { "name": "Create Rule", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/runs/rules", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new run rule." }, { "info": { "name": "Validate Rule", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/runs/rules/validate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Validate a rule by executing it with test data without creating a saved rule.\n\nThis endpoint allows testing LLM-as-judge evaluators before saving them. It accepts\na rule configuration (same as rule creation) and test data, executes the evaluator,\nand returns the evaluation results in the same format as batch_invoke_evaluator.\n\nOnly LLM-as-judge rules (evaluators) are supported. Code evaluators are not allowed.\n\nThe evaluator execution traces are written to the database (in the \"evaluators\"\nproje" }, { "info": { "name": "Update Rule", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/runs/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a run rule." }, { "info": { "name": "Delete Rule", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/runs/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a run rule." }, { "info": { "name": "Thread Preview", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/runs/threads/:thread_id", "params": [ { "name": "thread_id", "value": "", "type": "path" }, { "name": "session_id", "value": "", "type": "query" }, { "name": "select", "value": "", "type": "query" }, { "name": "variables", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get preview of a thread." }, { "info": { "name": "List Rule Logs", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/runs/rules/:rule_id/logs", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "start_time", "value": "", "type": "query" }, { "name": "end_time", "value": "", "type": "query" }, { "name": "session_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List logs for a particular rule" }, { "info": { "name": "List Rule Logs V2", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/runs/rules/:rule_id/logs/v2", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "backfill", "value": "", "type": "query" }, { "name": "start_time", "value": "", "type": "query" }, { "name": "end_time", "value": "", "type": "query" }, { "name": "session_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List logs for a particular rule with cursor-based pagination.\n\nThis endpoint handles S3-stored outcomes correctly by using run_outcomes_count\nto predict batch sizes and avoid over-fetching." }, { "info": { "name": "Get Last Applied Rule", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/runs/rules/:rule_id/last_applied", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "backfill", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get the last applied rule." }, { "info": { "name": "Trigger Rule", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/runs/rules/:rule_id/trigger", "params": [ { "name": "rule_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Trigger a run rule manually." }, { "info": { "name": "Trigger Rules", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/runs/rules/trigger", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Trigger an array of run rules manually." }, { "info": { "name": "Read Run", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/runs/:run_id", "params": [ { "name": "run_id", "value": "", "type": "path" }, { "name": "session_id", "value": "", "type": "query" }, { "name": "start_time", "value": "", "type": "query" }, { "name": "exclude_s3_stored_attributes", "value": "", "type": "query" }, { "name": "exclude_serialized", "value": "", "type": "query" }, { "name": "include_messages", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a specific run." }, { "info": { "name": "Update Run", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/runs/:run_id", "params": [ { "name": "run_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a run." }, { "info": { "name": "Read Run Share State", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/runs/:run_id/share", "params": [ { "name": "run_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get the state of sharing of a run." }, { "info": { "name": "Share Run", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/runs/:run_id/share", "params": [ { "name": "run_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Share a run." }, { "info": { "name": "Unshare Run", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/runs/:run_id/share", "params": [ { "name": "run_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Unshare a run." }, { "info": { "name": "Validate Runs Query", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/runs/query/validate", "body": { "type": "json", "data": "{}" } }, "docs": "Validate runs query syntax, returns errors for broken queries." }, { "info": { "name": "Query Runs", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/runs/query", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Query Runs" }, { "info": { "name": "Generate Query For Runs", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/runs/generate-query", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get runs filter expression query for a given natural language query." }, { "info": { "name": "Stats Runs", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/runs/stats", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all runs by query in body payload." }, { "info": { "name": "Group Runs", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/runs/group", "headers": [ { "name": "accept", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get runs grouped by an expression" }, { "info": { "name": "Stats Group Runs", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/runs/group/stats", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get stats for the grouped runs." }, { "info": { "name": "Delete Runs Abac", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/runs/delete/traces", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete specific runs by trace IDs." }, { "info": { "name": "Delete Runs", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/runs/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete specific runs by trace IDs." } ] }, { "info": { "name": "experiments", "type": "folder" }, "items": [ { "info": { "name": "Evaluate Experiment Adhoc", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/runs/experiments/:experiment_id/evaluate", "params": [ { "name": "experiment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Evaluate an existing experiment with a specific evaluator.\n\nThis triggers immediate evaluation using the run_over_dataset approach,\nprocessing runs in batches to handle large experiments efficiently." } ] }, { "info": { "name": "feedback", "type": "folder" }, "items": [ { "info": { "name": "List Feedback Formula Ep", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/feedback/formulas", "params": [ { "name": "dataset_id", "value": "", "type": "query" }, { "name": "session_id", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List feedback formulas for a given dataset or tracing project" }, { "info": { "name": "Create Feedback Formula Ep", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/feedback/formulas", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new feedback formula" }, { "info": { "name": "Get Feedback Formula Ep", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/feedback/formulas/:feedback_formula_id", "params": [ { "name": "feedback_formula_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a feedback formula by id" }, { "info": { "name": "Update Feedback Formula Ep", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/feedback/formulas/:feedback_formula_id", "params": [ { "name": "feedback_formula_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a feedback formula" }, { "info": { "name": "Delete Feedback Formula Endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/feedback/formulas/:feedback_formula_id", "params": [ { "name": "feedback_formula_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a feedback formula by id" }, { "info": { "name": "Read Feedback", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/feedback/:feedback_id", "params": [ { "name": "feedback_id", "value": "", "type": "path" }, { "name": "include_user_names", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a specific feedback." }, { "info": { "name": "Update Feedback", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/feedback/:feedback_id", "params": [ { "name": "feedback_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Replace an existing feedback entry with a new, modified entry." }, { "info": { "name": "Delete Feedback", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/feedback/:feedback_id", "params": [ { "name": "feedback_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a feedback." }, { "info": { "name": "Read Feedbacks", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/feedback", "params": [ { "name": "run", "value": "", "type": "query" }, { "name": "key", "value": "", "type": "query" }, { "name": "session", "value": "", "type": "query" }, { "name": "source", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "user", "value": "", "type": "query" }, { "name": "has_comment", "value": "", "type": "query" }, { "name": "has_score", "value": "", "type": "query" }, { "name": "level", "value": "", "type": "query" }, { "name": "max_created_at", "value": "", "type": "query" }, { "name": "min_created_at", "value": "", "type": "query" }, { "name": "include_user_names", "value": "", "type": "query" }, { "name": "comparative_experiment_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List all Feedback by query params." }, { "info": { "name": "Create Feedback", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/feedback", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new feedback." }, { "info": { "name": "Eagerly Create Feedback", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/feedback/eager", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new feedback.\n\nThis method is invoked under the assumption that the run\nis already visible in the app, thus already present in DB" }, { "info": { "name": "List Feedback Ingest Tokens", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/feedback/tokens", "params": [ { "name": "run_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List all feedback ingest tokens for a run." }, { "info": { "name": "Create Feedback Ingest Token", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/feedback/tokens", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new feedback ingest token." }, { "info": { "name": "Create Feedback With Token Get", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/feedback/tokens/:token", "params": [ { "name": "token", "value": "", "type": "path" }, { "name": "score", "value": "", "type": "query" }, { "name": "value", "value": "", "type": "query" }, { "name": "comment", "value": "", "type": "query" }, { "name": "correction", "value": "", "type": "query" } ] }, "docs": "Create a new feedback with a token." }, { "info": { "name": "Create Feedback With Token Post", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/feedback/tokens/:token", "params": [ { "name": "token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new feedback with a token." } ] }, { "info": { "name": "public", "type": "folder" }, "items": [ { "info": { "name": "Get Shared Run", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/public/:share_token/run", "params": [ { "name": "share_token", "value": "", "type": "path" }, { "name": "exclude_s3_stored_attributes", "value": "", "type": "query" } ] }, "docs": "Get the shared run." }, { "info": { "name": "Get Shared Run By Id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/public/:share_token/run/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "share_token", "value": "", "type": "path" }, { "name": "exclude_s3_stored_attributes", "value": "", "type": "query" } ] }, "docs": "Get the shared run." }, { "info": { "name": "Query Shared Runs", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/public/:share_token/runs/query", "params": [ { "name": "share_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get run by ids or the shared run if not specifed." }, { "info": { "name": "Read Shared Feedbacks", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/public/:share_token/feedbacks", "params": [ { "name": "share_token", "value": "", "type": "path" }, { "name": "run", "value": "", "type": "query" }, { "name": "key", "value": "", "type": "query" }, { "name": "session", "value": "", "type": "query" }, { "name": "source", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "user", "value": "", "type": "query" }, { "name": "has_comment", "value": "", "type": "query" }, { "name": "has_score", "value": "", "type": "query" }, { "name": "level", "value": "", "type": "query" } ] }, "docs": "Read Shared Feedbacks" }, { "info": { "name": "Read Shared Dataset", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/public/:share_token/datasets", "params": [ { "name": "share_token", "value": "", "type": "path" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query" }, { "name": "sort_by_desc", "value": "", "type": "query" } ] }, "docs": "Get dataset by ids or the shared dataset if not specifed." }, { "info": { "name": "Count Shared Examples", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/public/:share_token/examples/count", "params": [ { "name": "share_token", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "query" }, { "name": "as_of", "value": "", "type": "query", "description": "Only modifications made on or before this time are included. If None, the latest version of the dataset is used." }, { "name": "metadata", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" } ] }, "docs": "Count all examples by query params" }, { "info": { "name": "Read Shared Examples", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/public/:share_token/examples", "params": [ { "name": "share_token", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "query" }, { "name": "as_of", "value": "", "type": "query", "description": "Only modifications made on or before this time are included. If None, the latest version of the dataset is used." }, { "name": "metadata", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "select", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" } ] }, "docs": "Get example by ids or the shared example if not specifed." }, { "info": { "name": "Read Shared Dataset Tracer Sessions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/public/:share_token/datasets/sessions", "headers": [ { "name": "accept", "value": "" } ], "params": [ { "name": "share_token", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name_contains", "value": "", "type": "query" }, { "name": "dataset_version", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query" }, { "name": "sort_by_desc", "value": "", "type": "query" }, { "name": "sort_by_feedback_key", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "facets", "value": "", "type": "query" } ] }, "docs": "Get projects run on a dataset that has been shared." }, { "info": { "name": "Read Shared Dataset Tracer Sessions Bulk", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/public/datasets/sessions-bulk", "params": [ { "name": "share_tokens", "value": "", "type": "query" } ] }, "docs": "Get sessions from multiple datasets using share tokens." }, { "info": { "name": "Read Shared Dataset Examples With Runs", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/public/:share_token/examples/runs", "params": [ { "name": "share_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get examples with associated runs from sessions in a dataset that has been shared." }, { "info": { "name": "Read Shared Delta", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/public/:share_token/datasets/runs/delta", "params": [ { "name": "share_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Fetch the number of regressions/improvements for each example in a dataset, between sessions[0] and sessions[1]." }, { "info": { "name": "Read Shared Delta Stream", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/public/:share_token/datasets/runs/delta/stream", "params": [ { "name": "share_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stream feedback deltas for multiple feedback keys.\n\nReturns results in chunks as they become available. Each chunk contains\nresults for one or more feedback keys. Errors for individual chunks are\nincluded in the response rather than failing the entire operation.\n\nResponse format (SSE):\n event: data\n data: {\"feedback_deltas\": {\"key1\": {session_id: {...}}, ...}, \"errors\": null}\n\n event: data\n data: {\"feedback_deltas\": {\"key2\": {...}}, \"errors\": null}\n\n event: end" }, { "info": { "name": "Query Shared Dataset Runs", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/public/:share_token/datasets/runs/query", "params": [ { "name": "share_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get runs in projects run over a dataset that has been shared." }, { "info": { "name": "Generate Query For Shared Dataset Runs", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/public/:share_token/datasets/runs/generate-query", "params": [ { "name": "share_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get runs in projects run over a dataset that has been shared." }, { "info": { "name": "Stats Shared Dataset Runs", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/public/:share_token/datasets/runs/stats", "params": [ { "name": "share_token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get run stats in projects run over a dataset that has been shared." }, { "info": { "name": "Read Shared Dataset Run", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/public/:share_token/datasets/runs/:run_id", "params": [ { "name": "run_id", "value": "", "type": "path" }, { "name": "share_token", "value": "", "type": "path" }, { "name": "exclude_s3_stored_attributes", "value": "", "type": "query" } ] }, "docs": "Get runs in projects run over a dataset that has been shared." }, { "info": { "name": "Read Shared Dataset Feedback", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/public/:share_token/datasets/feedback", "params": [ { "name": "share_token", "value": "", "type": "path" }, { "name": "run", "value": "", "type": "query" }, { "name": "key", "value": "", "type": "query" }, { "name": "session", "value": "", "type": "query" }, { "name": "source", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "user", "value": "", "type": "query" }, { "name": "has_comment", "value": "", "type": "query" }, { "name": "has_score", "value": "", "type": "query" }, { "name": "level", "value": "", "type": "query" } ] }, "docs": "Get feedback for runs in projects run over a dataset that has been shared." }, { "info": { "name": "Read Shared Comparative Experiments", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/public/:share_token/datasets/comparative", "params": [ { "name": "share_token", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" }, { "name": "name_contains", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query" }, { "name": "sort_by_desc", "value": "", "type": "query" } ] }, "docs": "Get all comparative experiments for a given dataset." }, { "info": { "name": "Get Message Json Schema", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/public/schemas/:version/message.json", "params": [ { "name": "version", "value": "", "type": "path" } ] }, "docs": "Get Message Json Schema" }, { "info": { "name": "Get Tool Def Json Schema", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/public/schemas/:version/tooldef.json", "params": [ { "name": "version", "value": "", "type": "path" } ] }, "docs": "Get Tool Def Json Schema" } ] }, { "info": { "name": "annotation-queues", "type": "folder" }, "items": [ { "info": { "name": "Get Annotation Queues", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/annotation-queues", "params": [ { "name": "ids", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name_contains", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "tag_value_id", "value": "", "type": "query" }, { "name": "dataset_id", "value": "", "type": "query" }, { "name": "queue_type", "value": "", "type": "query" }, { "name": "assigned_to_me", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query" }, { "name": "sort_by_desc", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Annotation Queues" }, { "info": { "name": "Create Annotation Queue", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/annotation-queues", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create Annotation Queue" }, { "info": { "name": "Delete Annotation Queues", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/annotation-queues", "params": [ { "name": "queue_ids", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete multiple annotation queues with partial success support.\n\nReturns:\n - 200: All queues deleted successfully\n - 207: Some queues deleted successfully, some failed" }, { "info": { "name": "Populate Annotation Queue", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/annotation-queues/populate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Populate annotation queue with runs from an experiment." }, { "info": { "name": "Get Annotation Queue", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/annotation-queues/:queue_id", "params": [ { "name": "queue_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Annotation Queue" }, { "info": { "name": "Update Annotation Queue", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/annotation-queues/:queue_id", "params": [ { "name": "queue_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update Annotation Queue" }, { "info": { "name": "Delete Annotation Queue", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/annotation-queues/:queue_id", "params": [ { "name": "queue_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete Annotation Queue" }, { "info": { "name": "Get Runs From Annotation Queue", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/annotation-queues/:queue_id/runs", "params": [ { "name": "queue_id", "value": "", "type": "path" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "archived", "value": "", "type": "query" }, { "name": "include_stats", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Runs From Annotation Queue" }, { "info": { "name": "Add Runs To Annotation Queue", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/annotation-queues/:queue_id/runs", "params": [ { "name": "queue_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Add Runs To Annotation Queue" }, { "info": { "name": "Add Runs To Annotation Queue By Key", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/annotation-queues/:queue_id/runs/by-key", "params": [ { "name": "queue_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Add Runs To Annotation Queue By Key" }, { "info": { "name": "Export Annotation Queue Archived Runs", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/annotation-queues/:queue_id/export", "params": [ { "name": "queue_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Export Annotation Queue Archived Runs" }, { "info": { "name": "Get Run From Annotation Queue", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/annotation-queues/:queue_id/run/:index", "params": [ { "name": "queue_id", "value": "", "type": "path" }, { "name": "index", "value": "", "type": "path" }, { "name": "include_extra", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a run from an annotation queue" }, { "info": { "name": "Get Annotation Queues For Run", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/annotation-queues/:run_id/queues", "params": [ { "name": "run_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Annotation Queues For Run" }, { "info": { "name": "Update Run In Annotation Queue", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/annotation-queues/:queue_id/runs/:queue_run_id", "params": [ { "name": "queue_id", "value": "", "type": "path" }, { "name": "queue_run_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update Run In Annotation Queue" }, { "info": { "name": "Delete Run From Annotation Queue", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/annotation-queues/:queue_id/runs/:queue_run_id", "params": [ { "name": "queue_id", "value": "", "type": "path" }, { "name": "queue_run_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete Run From Annotation Queue" }, { "info": { "name": "Delete Runs From Annotation Queue", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/annotation-queues/:queue_id/runs/delete", "params": [ { "name": "queue_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete Runs From Annotation Queue" }, { "info": { "name": "Get Total Size From Annotation Queue", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/annotation-queues/:queue_id/total_size", "params": [ { "name": "queue_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Total Size From Annotation Queue" }, { "info": { "name": "Get Total Archived From Annotation Queue", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/annotation-queues/:queue_id/total_archived", "params": [ { "name": "queue_id", "value": "", "type": "path" }, { "name": "start_time", "value": "", "type": "query" }, { "name": "end_time", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Total Archived From Annotation Queue" }, { "info": { "name": "Get Size From Annotation Queue", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/annotation-queues/:queue_id/size", "params": [ { "name": "queue_id", "value": "", "type": "path" }, { "name": "status", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Size From Annotation Queue" }, { "info": { "name": "Create Identity Annotation Queue Run Status", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/annotation-queues/status/:annotation_queue_run_id", "params": [ { "name": "annotation_queue_run_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create Identity Annotation Queue Run Status" }, { "info": { "name": "Resolve Annotation Queue Run", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/annotation-queues/:queue_id/runs/resolve/:queue_run_id", "params": [ { "name": "queue_id", "value": "", "type": "path" }, { "name": "queue_run_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Resolve a queue run ID to its section and run data for deep linking." } ] }, { "info": { "name": "ace", "type": "folder" }, "items": [ { "info": { "name": "Execute", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/ace/execute", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Execute some custom code for testing purposes." } ] }, { "info": { "name": "bulk-exports", "type": "folder" }, "items": [ { "info": { "name": "Get Bulk Exports", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/bulk-exports", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get the current workspace's bulk exports" }, { "info": { "name": "Create Bulk Export", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/bulk-exports", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new bulk export" }, { "info": { "name": "Get Bulk Export Destinations", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/bulk-exports/destinations", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get the current workspace's bulk export destinations" }, { "info": { "name": "Create Bulk Export Destination", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/bulk-exports/destinations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new bulk export destination" }, { "info": { "name": "Get Bulk Export Runs Filtered", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/bulk-exports/runs", "params": [ { "name": "source_bulk_export_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all bulk export runs for exports that were created from a scheduled bulk export" }, { "info": { "name": "Get Bulk Export", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/bulk-exports/:bulk_export_id", "params": [ { "name": "bulk_export_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a single bulk export by ID" }, { "info": { "name": "Cancel Bulk Export", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/bulk-exports/:bulk_export_id", "params": [ { "name": "bulk_export_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Cancel a bulk export by ID" }, { "info": { "name": "Get Bulk Export Destination", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/bulk-exports/destinations/:destination_id", "params": [ { "name": "destination_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a single bulk export destination by ID" }, { "info": { "name": "Update Bulk Export Destination", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/bulk-exports/destinations/:destination_id", "params": [ { "name": "destination_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a bulk export destination" }, { "info": { "name": "Get Bulk Export Runs", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/bulk-exports/:bulk_export_id/runs", "params": [ { "name": "bulk_export_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a bulk export's runs" }, { "info": { "name": "Get Bulk Export Run", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/bulk-exports/:bulk_export_id/runs/:run_id", "params": [ { "name": "bulk_export_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a single bulk export's run by ID" } ] }, { "info": { "name": "feedback-configs", "type": "folder" }, "items": [ { "info": { "name": "List Feedback Configs Endpoint", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/feedback-configs", "params": [ { "name": "key", "value": "", "type": "query" }, { "name": "name_contains", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort_by_desc", "value": "", "type": "query" }, { "name": "read_after_write", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List Feedback Configs Endpoint" }, { "info": { "name": "Create Feedback Config Endpoint", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/feedback-configs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create Feedback Config Endpoint" }, { "info": { "name": "Update Feedback Config Endpoint", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/feedback-configs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update Feedback Config Endpoint" }, { "info": { "name": "Delete Feedback Config Endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/feedback-configs", "params": [ { "name": "feedback_key", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Soft delete a feedback config by marking it as deleted.\n\nThe config can be recreated later with the same key (simple reuse pattern).\nExisting feedback records with this key will remain unchanged." } ] }, { "info": { "name": "model-price-map", "type": "folder" }, "items": [ { "info": { "name": "Read Model Price Map", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/model-price-map", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Read Model Price Map" }, { "info": { "name": "Create New Model Price", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/model-price-map", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create New Model Price" }, { "info": { "name": "Update Model Price", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/model-price-map/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update Model Price" }, { "info": { "name": "Delete Model Price", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/model-price-map/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete Model Price" } ] }, { "info": { "name": "usage-limits", "type": "folder" }, "items": [ { "info": { "name": "List Usage Limits", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/usage-limits", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List out the configured usage limits for a given tenant." }, { "info": { "name": "Upsert Usage Limit", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/usage-limits", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new usage limit." }, { "info": { "name": "List Org Usage Limits", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/usage-limits/org", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List out the configured usage limits for a given organization." }, { "info": { "name": "Delete Usage Limit", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/usage-limits/:usage_limit_id", "params": [ { "name": "usage_limit_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a specific usage limit." } ] }, { "info": { "name": "prompts", "type": "folder" }, "items": [ { "info": { "name": "Invoke Prompt", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/prompts/invoke_prompt", "body": { "type": "json", "data": "{}" } }, "docs": "Invoke Prompt" }, { "info": { "name": "Prompt Canvas", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/prompts/canvas", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Prompt Canvas" } ] }, { "info": { "name": "prompt-webhooks", "type": "folder" }, "items": [ { "info": { "name": "List Prompt Webhooks", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/prompt-webhooks", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List all prompt webhooks for the current tenant." }, { "info": { "name": "Create Prompt Webhook", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/prompt-webhooks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new prompt webhook." }, { "info": { "name": "Get Prompt Webhook", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/prompt-webhooks/:webhook_id", "params": [ { "name": "webhook_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a specific prompt webhook." }, { "info": { "name": "Update Prompt Webhook", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/prompt-webhooks/:webhook_id", "params": [ { "name": "webhook_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a specific prompt webhook." }, { "info": { "name": "Delete Prompt Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/prompt-webhooks/:webhook_id", "params": [ { "name": "webhook_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a specific prompt webhook." }, { "info": { "name": "Test Prompt Webhook", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/prompt-webhooks/test", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Test a specific prompt webhook." } ] }, { "info": { "name": "playground-settings", "type": "folder" }, "items": [ { "info": { "name": "List Playground Settings", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/playground-settings", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all playground settings for this tenant id." }, { "info": { "name": "Create Playground Settings", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/playground-settings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create playground settings." }, { "info": { "name": "Get Playground Settings", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/playground-settings/:playground_settings_id", "params": [ { "name": "playground_settings_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a single playground settings by ID." }, { "info": { "name": "Update Playground Settings", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/playground-settings/:playground_settings_id", "params": [ { "name": "playground_settings_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update playground settings." }, { "info": { "name": "Delete Playground Settings", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/playground-settings/:playground_settings_id", "params": [ { "name": "playground_settings_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete playground settings." } ] }, { "info": { "name": "charts", "type": "folder" }, "items": [ { "info": { "name": "Clone Section", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/charts/section/clone", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Clone a dashboard." }, { "info": { "name": "Read Sections", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/charts/section", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "title_contains", "value": "", "type": "query" }, { "name": "ids", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query" }, { "name": "sort_by_desc", "value": "", "type": "query" }, { "name": "tag_value_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all sections for the tenant." }, { "info": { "name": "Create Section", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/charts/section", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new section." }, { "info": { "name": "Read Charts", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/charts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all charts for the tenant." }, { "info": { "name": "Read Chart Preview", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/charts/preview", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a preview for a chart without actually creating it." }, { "info": { "name": "Create Chart", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/charts/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new chart." }, { "info": { "name": "Read Single Chart", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/charts/:chart_id", "params": [ { "name": "chart_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a single chart by ID." }, { "info": { "name": "Update Chart", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/charts/:chart_id", "params": [ { "name": "chart_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a chart." }, { "info": { "name": "Delete Chart", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/charts/:chart_id", "params": [ { "name": "chart_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a chart." }, { "info": { "name": "Read Single Section", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/charts/section/:section_id", "params": [ { "name": "section_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a single section by ID." }, { "info": { "name": "Update Section", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/charts/section/:section_id", "params": [ { "name": "section_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a section." }, { "info": { "name": "Delete Section", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/charts/section/:section_id", "params": [ { "name": "section_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a section." }, { "info": { "name": "Org Read Sections", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/org-charts/section", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "title_contains", "value": "", "type": "query" }, { "name": "ids", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query" }, { "name": "sort_by_desc", "value": "", "type": "query" }, { "name": "tag_value_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all sections for the tenant." }, { "info": { "name": "Org Create Section", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/org-charts/section", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new section." }, { "info": { "name": "Org Read Charts", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/org-charts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all charts for the tenant." }, { "info": { "name": "Org Read Chart Preview", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/org-charts/preview", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a preview for a chart without actually creating it." }, { "info": { "name": "Org Create Chart", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/org-charts/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new chart." }, { "info": { "name": "Org Read Single Chart", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/org-charts/:chart_id", "params": [ { "name": "chart_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a single chart by ID." }, { "info": { "name": "Org Update Chart", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/org-charts/:chart_id", "params": [ { "name": "chart_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a chart." }, { "info": { "name": "Org Delete Chart", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/org-charts/:chart_id", "params": [ { "name": "chart_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a chart." }, { "info": { "name": "Org Read Single Section", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/org-charts/section/:section_id", "params": [ { "name": "section_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a single section by ID." }, { "info": { "name": "Org Update Section", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/org-charts/section/:section_id", "params": [ { "name": "section_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a section." }, { "info": { "name": "Org Delete Section", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/org-charts/section/:section_id", "params": [ { "name": "section_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a section." } ] }, { "info": { "name": "mcp", "type": "folder" }, "items": [ { "info": { "name": "Get Tools", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/mcp/tools", "params": [ { "name": "url", "value": "", "type": "query" }, { "name": "oauth_provider_id", "value": "", "type": "query" }, { "name": "ls_user_id", "value": "", "type": "query" }, { "name": "force_refresh", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Return MCP tools — from cache if fresh, otherwise by fetching from remote.\n\nOn cache miss, tries manifest fetch first (fast), then falls back to full\nMCP handshake. Caches the result before returning.\n\nPass force_refresh=true to bypass the cache and always fetch from the\nremote server (the result is still cached via upsert for future requests).\n\nThe ls_user_id query parameter allows service-key callers (which don't carry\nls_user_id in auth) to specify the user for per-user OAuth cache lookups." }, { "info": { "name": "Invalidate Tools Cache", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/mcp/tools", "params": [ { "name": "url", "value": "", "type": "query" }, { "name": "oauth_provider_id", "value": "", "type": "query" }, { "name": "ls_user_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Invalidate cached MCP tools for a given server URL.\n\nCalled when a tool call fails with a stale-tools error, so subsequent\nrequests to GET /mcp/tools will re-fetch from the remote server." }, { "info": { "name": "Proxy Get", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/mcp/proxy", "params": [ { "name": "url", "value": "", "type": "query" }, { "name": "accept_stream", "value": "", "type": "query" }, { "name": "timeout", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Proxy Get" }, { "info": { "name": "Proxy", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/mcp/proxy", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Proxy" } ] }, { "info": { "name": "auth", "type": "folder" }, "items": [ { "info": { "name": "Login", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/login" }, "docs": "Login" }, { "info": { "name": "Send Sso Email Confirmation", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/sso/email-verification/send", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Send an email to confirm the email address for an SSO user." }, { "info": { "name": "Check Sso Email Verification Status", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/sso/email-verification/status", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve the email verification status of an SSO user." }, { "info": { "name": "Confirm Sso User Email", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/sso/email-verification/confirm", "body": { "type": "json", "data": "{}" } }, "docs": "Confirm the email of an SSO user." }, { "info": { "name": "Get Sso Settings", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/sso/settings/:sso_login_slug", "params": [ { "name": "sso_login_slug", "value": "", "type": "path" } ] }, "docs": "Get SSO provider settings from login slug." }, { "info": { "name": "Lookup Sso By Email", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/sso/email-lookup", "body": { "type": "json", "data": "{}" } }, "docs": "Look up SSO providers available for a SCIM-provisioned email address." }, { "info": { "name": "Get public auth info", "type": "http" }, "http": { "method": "GET", "url": "/auth/public", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns public authentication information for the current workspace-level session." } ] }, { "info": { "name": "api-key", "type": "folder" }, "items": [ { "info": { "name": "Get Api Keys", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/api-key", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get the current tenant's API keys" }, { "info": { "name": "Generate Api Key", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/api-key", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Generate an api key for the user" }, { "info": { "name": "Delete Api Key", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/api-key/:api_key_id", "params": [ { "name": "api_key_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete an api key for the user" }, { "info": { "name": "Get Personal Access Tokens", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/api-key/current", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "DEPRECATED: Use /orgs/current/personal-access-tokens instead" }, { "info": { "name": "Generate Personal Access Token", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/api-key/current", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "DEPRECATED: Use /orgs/current/personal-access-tokens instead" }, { "info": { "name": "Delete Personal Access Token", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/api-key/current/:pat_id", "params": [ { "name": "pat_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "DEPRECATED: Use /orgs/current/personal-access-tokens/{pat_id} instead" } ] }, { "info": { "name": "tenant", "type": "folder" }, "items": [ { "info": { "name": "List Tenants", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tenants", "params": [ { "name": "skip_create", "value": "", "type": "query" }, { "name": "include_deleted", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all tenants visible to this auth" }, { "info": { "name": "Create Tenant", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/tenants", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new organization and corresponding workspace." } ] }, { "info": { "name": "me", "type": "folder" }, "items": [ { "info": { "name": "Get Onboarding State", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/me/onboarding_state", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get onboarding state for the current user." }, { "info": { "name": "Create Onboarding State", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/me/onboarding_state", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Initialize onboarding state for the current user." }, { "info": { "name": "Update Onboarding State Field", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/me/onboarding_state/:field", "params": [ { "name": "field", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a specific onboarding completion field for the current user.\n\nValid fields:\n- tracing_completed_at\n- lgstudio_completed_at\n- playground_completed_at\n- evaluation_completed_at\n- success_viewed_at" }, { "info": { "name": "Get Ls User Id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/me/ls_user_id", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the LangSmith user ID for the current user." }, { "info": { "name": "Get the authenticated user's provider user ID", "type": "http" }, "http": { "method": "GET", "url": "/me/providers/:providerType", "params": [ { "name": "providerType", "value": "", "type": "path", "description": "Provider type (e.g. slack, github)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the provider user ID associated with the authenticated user for a given provider type, or null if not set. Scoped to the current tenant." } ] }, { "info": { "name": "service-accounts", "type": "folder" }, "items": [ { "info": { "name": "Get Service Accounts", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/service-accounts", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get the current organization's service accounts." }, { "info": { "name": "Create Service Account", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/service-accounts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a service account" }, { "info": { "name": "Delete Service Account", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/service-accounts/:service_account_id", "params": [ { "name": "service_account_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a service account" } ] }, { "info": { "name": "Default", "type": "folder" }, "items": [ { "info": { "name": "Ok", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/ok" }, "docs": "Ok" } ] }, { "info": { "name": "settings", "type": "folder" }, "items": [ { "info": { "name": "Get Settings", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/settings", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get settings." }, { "info": { "name": "Set Tenant Handle", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/settings/handle", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Set tenant handle." } ] }, { "info": { "name": "repos", "type": "folder" }, "items": [ { "info": { "name": "List Repos", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/repos", "params": [ { "name": "with_latest_manifest", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "tenant_handle", "value": "", "type": "query" }, { "name": "tenant_id", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query" }, { "name": "has_commits", "value": "", "type": "query" }, { "name": "tags", "value": "", "type": "query" }, { "name": "is_archived", "value": "", "type": "query" }, { "name": "is_public", "value": "", "type": "query" }, { "name": "upstream_repo_owner", "value": "", "type": "query" }, { "name": "upstream_repo_handle", "value": "", "type": "query" }, { "name": "tag_value_id", "value": "", "type": "query" }, { "name": "repo_type", "value": "", "type": "query" }, { "name": "repo_types", "value": "", "type": "query" }, { "name": "source", "value": "", "type": "query" }, { "name": "sort_field", "value": "", "type": "query" }, { "name": "sort_direction", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all repos." }, { "info": { "name": "Create Repo", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/repos", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a repo." }, { "info": { "name": "Delete Repos", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/repos", "params": [ { "name": "repo_ids", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete multiple repos with partial success support.\n\nReturns:\n - 200: All repos deleted successfully\n - 207: Some repos deleted successfully, some failed" }, { "info": { "name": "Get Repo", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/repos/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a repo." }, { "info": { "name": "Update Repo", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/repos/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a repo." }, { "info": { "name": "Delete Repo", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/repos/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a repo." }, { "info": { "name": "Fork Repo", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/repos/:owner/:repo/fork", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Fork a repo." }, { "info": { "name": "List Repo Tags", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/repos/tags", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "tenant_handle", "value": "", "type": "query" }, { "name": "tenant_id", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query" }, { "name": "has_commits", "value": "", "type": "query" }, { "name": "tags", "value": "", "type": "query" }, { "name": "is_archived", "value": "", "type": "query" }, { "name": "is_public", "value": "", "type": "query" }, { "name": "upstream_repo_owner", "value": "", "type": "query" }, { "name": "upstream_repo_handle", "value": "", "type": "query" }, { "name": "tag_value_id", "value": "", "type": "query" }, { "name": "repo_type", "value": "", "type": "query" }, { "name": "repo_types", "value": "", "type": "query" }, { "name": "source", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get all repo tags." }, { "info": { "name": "Optimize Prompt Job", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/repos/optimize-job", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Optimize prompt" } ] }, { "info": { "name": "likes", "type": "folder" }, "items": [ { "info": { "name": "Like Repo", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/likes/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Like a repo." } ] }, { "info": { "name": "comments", "type": "folder" }, "items": [ { "info": { "name": "Get Comments", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/comments/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Comments" }, { "info": { "name": "Create Comment", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/comments/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create Comment" }, { "info": { "name": "Get Sub Comments", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/comments/:owner/:repo/:parent_comment_id", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "parent_comment_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Sub Comments" }, { "info": { "name": "Create Sub Comment", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/comments/:owner/:repo/:parent_comment_id", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "parent_comment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create Sub Comment" }, { "info": { "name": "Like Comment", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/comments/:owner/:repo/:parent_comment_id/like", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "parent_comment_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Like Comment" }, { "info": { "name": "Unlike Comment", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/comments/:owner/:repo/:parent_comment_id/like", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "parent_comment_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Unlike Comment" } ] }, { "info": { "name": "tags", "type": "folder" }, "items": [ { "info": { "name": "Get Tags", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/repos/:owner/:repo/tags", "params": [ { "name": "repo", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Tags" }, { "info": { "name": "Create Tag", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/repos/:owner/:repo/tags", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a tag. Requires repo ownership, prompts:tag permission, or ABAC grant." }, { "info": { "name": "Get Tag", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/repos/:owner/:repo/tags/:tag_name", "params": [ { "name": "repo", "value": "", "type": "path" }, { "name": "tag_name", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Tag" }, { "info": { "name": "Update Tag", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/repos/:owner/:repo/tags/:tag_name", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "tag_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a tag. Requires repo ownership, prompts:tag permission, or ABAC grant." }, { "info": { "name": "Delete Tag", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/repos/:owner/:repo/tags/:tag_name", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "tag_name", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a tag. Requires repo ownership, prompts:tag permission, or ABAC grant." } ] }, { "info": { "name": "ownerships", "type": "folder" }, "items": [ { "info": { "name": "List Repo Owners", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/repos/:owner/:repo/owners", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List all owners of a repo.\n\nRequires read permission on the repo." }, { "info": { "name": "Add Repo Owner", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/repos/:owner/:repo/owners", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Add an owner to a repo.\n\nRequires being an existing owner of the repo." }, { "info": { "name": "Remove Repo Owner", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/repos/:owner/:repo/owners", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Remove an owner from a repo.\n\nRequires being an existing owner of the repo." } ] }, { "info": { "name": "optimization-jobs", "type": "folder" }, "items": [ { "info": { "name": "List Jobs", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/repos/:owner/:repo/optimization-jobs", "params": [ { "name": "repo", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List all prompt optimization jobs." }, { "info": { "name": "Create Job", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/repos/:owner/:repo/optimization-jobs", "params": [ { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new prompt optimization job." }, { "info": { "name": "Get Job", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/repos/:owner/:repo/optimization-jobs/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a specific optimization job." }, { "info": { "name": "Update Job", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/repos/:owner/:repo/optimization-jobs/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Replace an existing prompt optimization job with a new, modified job." }, { "info": { "name": "Delete Job", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/repos/:owner/:repo/optimization-jobs/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a prompt optimization job." }, { "info": { "name": "List Job Logs", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/repos/:owner/:repo/optimization-jobs/:job_id/logs", "params": [ { "name": "job_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List all logs for a specific prompt optimization job." }, { "info": { "name": "Create Log", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/repos/:owner/:repo/optimization-jobs/:job_id/logs", "params": [ { "name": "job_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new log entry for a prompt optimization job." }, { "info": { "name": "Get Log", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/repos/:owner/:repo/optimization-jobs/:job_id/logs/:log_id", "params": [ { "name": "log_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a specific prompt optimization job log." }, { "info": { "name": "Delete Log", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/repos/:owner/:repo/optimization-jobs/:job_id/logs/:log_id", "params": [ { "name": "log_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a prompt optimization job log." } ] }, { "info": { "name": "oauth", "type": "folder" }, "items": [ { "info": { "name": "Get OAuth2 authorization server metadata", "type": "http" }, "http": { "method": "GET", "url": "/.well-known/oauth-authorization-server", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns OAuth2 authorization server metadata per RFC 8414, including supported endpoints, grant types, and response types." }, { "info": { "name": "Initiate OAuth2 authorization", "type": "http" }, "http": { "method": "GET", "url": "/oauth/authorize", "params": [ { "name": "response_type", "value": "", "type": "query", "description": "Must be 'code'" }, { "name": "client_id", "value": "", "type": "query", "description": "OAuth2 client ID" }, { "name": "redirect_uri", "value": "", "type": "query", "description": "Redirect URI registered with the client" }, { "name": "code_challenge", "value": "", "type": "query", "description": "PKCE code challenge" }, { "name": "code_challenge_method", "value": "", "type": "query", "description": "PKCE method, must be 'S256'" }, { "name": "state", "value": "", "type": "query", "description": "Opaque state value to prevent CSRF" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Validates authorization request parameters and redirects to the frontend consent page per RFC 6749." }, { "info": { "name": "Approve OAuth2 authorization request", "type": "http" }, "http": { "method": "POST", "url": "/oauth/authorize/approve", "body": { "type": "multipart-form", "data": [ { "name": "organization_id", "type": "text", "value": "" }, { "name": "workspace_id", "type": "text", "value": "" }, { "name": "client_id", "type": "text", "value": "" }, { "name": "redirect_uri", "type": "text", "value": "" }, { "name": "code_challenge", "type": "text", "value": "" }, { "name": "code_challenge_method", "type": "text", "value": "" }, { "name": "state", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Issues an authorization code after the authenticated user approves the request. Called by the frontend consent page. Requires authentication." }, { "info": { "name": "Authorize a device code", "type": "http" }, "http": { "method": "POST", "url": "/oauth/device/authorize", "body": { "type": "multipart-form", "data": [ { "name": "organization_id", "type": "text", "value": "" }, { "name": "workspace_id", "type": "text", "value": "" }, { "name": "user_code", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Marks a device code as authorized for the authenticated user. Called by the /activate page when the user enters their user code. Requires authentication." }, { "info": { "name": "Request OAuth2 device authorization", "type": "http" }, "http": { "method": "POST", "url": "/oauth/device/code", "body": { "type": "multipart-form", "data": [ { "name": "client_id", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Issues a device code and user code for the device authorization flow per RFC 8628." }, { "info": { "name": "Register an OAuth2 dynamic client", "type": "http" }, "http": { "method": "POST", "url": "/oauth/register", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Public RFC 7591 Dynamic Client Registration endpoint. Only mints public clients with loopback HTTP or HTTPS-with-domain redirect URIs. Body limit 8 KB." }, { "info": { "name": "Revoke an OAuth2 token", "type": "http" }, "http": { "method": "POST", "url": "/oauth/revoke", "body": { "type": "multipart-form", "data": [ { "name": "token", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Revokes an access token or refresh token per RFC 7009. Always returns 200 regardless of whether the token was found." }, { "info": { "name": "Exchange grant for OAuth2 tokens", "type": "http" }, "http": { "method": "POST", "url": "/oauth/token", "body": { "type": "multipart-form", "data": [ { "name": "grant_type", "type": "text", "value": "" }, { "name": "client_id", "type": "text", "value": "" }, { "name": "code", "type": "text", "value": "" }, { "name": "code_verifier", "type": "text", "value": "" }, { "name": "redirect_uri", "type": "text", "value": "" }, { "name": "device_code", "type": "text", "value": "" }, { "name": "refresh_token", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Token endpoint that dispatches by grant_type: authorization_code, urn:ietf:params:oauth:grant-type:device_code, or refresh_token." } ] }, { "info": { "name": "gateway", "type": "folder" }, "items": [ { "info": { "name": "Proxy Anthropic Messages through the LLM Gateway", "type": "http" }, "http": { "method": "POST", "url": "/anthropic/v1/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Forwards an Anthropic Messages API request to api.anthropic.com.\nThe gateway injects the workspace's stored ANTHROPIC_API_KEY\nunless the request carries a Claude-Code-style OAuth bearer\n(`Authorization: Bearer sk-ant-oat01-...`), in which case the\nbearer is forwarded as-is and the workspace key is not used.\nSpend-cap and guard policies apply in both modes.\n\nStreaming (`stream: true`) responses are forwarded as\n`text/event-stream` chunks. Non-streaming responses are\nforwarded as `application/json" }, { "info": { "name": "Proxy Google Gemini generateContent through the LLM Gateway", "type": "http" }, "http": { "method": "POST", "url": "/gemini/v1beta/models/:model", "params": [ { "name": "model", "value": "", "type": "path", "description": "Model + action, e.g. `gemini-2.0-flash:generateContent` or `gemini-2.0-flash:streamGenerateContent`" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Forwards a Gemini v1beta `generateContent` or\n`streamGenerateContent` request to\ngenerativelanguage.googleapis.com. The gateway injects the\nworkspace's stored GOOGLE_API_KEY as the `x-goog-api-key`\nheader; any client-supplied `?key=` query parameter is\nstripped before forwarding so the workspace credential is the\nonly one in play. Spend-cap and guard policies apply.\n\n`streamGenerateContent` responses are forwarded as\n`text/event-stream`; `generateContent` responses are\nforwarded as `application/" }, { "info": { "name": "Proxy OpenAI Chat Completions through the LLM Gateway", "type": "http" }, "http": { "method": "POST", "url": "/openai/v1/chat/completions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Forwards an OpenAI Chat Completions request to api.openai.com.\nThe request body is the unmodified OpenAI request shape; the\ngateway injects the workspace's stored OPENAI_API_KEY, applies\nspend-cap and guard policies, and emits a LangSmith trace span\nfor the call.\n\nStreaming (`stream: true`) responses are forwarded as\n`text/event-stream` chunks. Non-streaming responses are\nforwarded as `application/json`." }, { "info": { "name": "Proxy OpenAI Responses through the LLM Gateway", "type": "http" }, "http": { "method": "POST", "url": "/openai/v1/responses", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Forwards an OpenAI Responses API request to api.openai.com.\nSame auth, policy, and tracing semantics as Chat Completions —\nthe workspace's OPENAI_API_KEY is injected by the gateway and\nthe request body is forwarded verbatim." } ] }, { "info": { "name": "hub_environments", "type": "folder" }, "items": [ { "info": { "name": "List hub environments", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/hub/environments", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the hub environments model for the current tenant.\nReturns 404 if no custom configuration exists." }, { "info": { "name": "Create hub environments model", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/hub/environments", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Creates the hub environments configuration for the current tenant." }, { "info": { "name": "Update hub environments model", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/hub/environments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Model ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Replaces the environments array on an existing model." }, { "info": { "name": "Delete hub environments model", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/hub/environments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Model ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Deletes the hub environments configuration. Tenant reverts to defaults." } ] }, { "info": { "name": "sandboxes", "type": "folder" }, "items": [ { "info": { "name": "Get sandbox access decision", "type": "http" }, "http": { "method": "GET", "url": "/auth/sandbox-access", "params": [ { "name": "sandbox_id", "value": "", "type": "query", "description": "Sandbox claim UUID" }, { "name": "action", "value": "", "type": "query", "description": "Runtime action: exec | file | tunnel | proxy" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Combines authn + per-sandbox authz for runtime access. Returns the caller's PublicAuthInfo on allow (HTTP 200) or a 403 with the deny reason on deny." }, { "info": { "name": "List sandbox claims", "type": "http" }, "http": { "method": "GET", "url": "/v2/sandboxes/boxes", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results" }, { "name": "offset", "value": "", "type": "query", "description": "Pagination offset" }, { "name": "name_contains", "value": "", "type": "query", "description": "Filter by name substring" }, { "name": "status", "value": "", "type": "query", "description": "Filter by status (provisioning, ready, failed, stopped, deleting)" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort column (name, status, created_at)" }, { "name": "sort_direction", "value": "", "type": "query", "description": "Sort direction (asc, desc)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List sandbox claims for the authenticated tenant, with optional filtering, sorting, and pagination." }, { "info": { "name": "Create a sandbox claim", "type": "http" }, "http": { "method": "POST", "url": "/v2/sandboxes/boxes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new sandbox from a snapshot. The snapshot may be identified by `snapshot_id` (UUID) or by `snapshot_name` (tenant-scoped unique name); exactly one must be set." }, { "info": { "name": "Batch delete sandbox claims", "type": "http" }, "http": { "method": "POST", "url": "/v2/sandboxes/boxes/batch-delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete multiple sandbox claims by name or UUID in a single request." }, { "info": { "name": "Get a sandbox claim", "type": "http" }, "http": { "method": "GET", "url": "/v2/sandboxes/boxes/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Sandbox claim display name" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Retrieve a sandbox claim by name. Stale provisioning claims are auto-failed." }, { "info": { "name": "Update a sandbox claim", "type": "http" }, "http": { "method": "PATCH", "url": "/v2/sandboxes/boxes/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Current sandbox claim display name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update a sandbox claim's display name. The name must be unique within the tenant." }, { "info": { "name": "Delete a sandbox claim", "type": "http" }, "http": { "method": "DELETE", "url": "/v2/sandboxes/boxes/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Sandbox claim display name or UUID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a sandbox claim by name or UUID. Tears down the sandbox runtime and removes the DB record." }, { "info": { "name": "Generate a service access token", "type": "http" }, "http": { "method": "POST", "url": "/v2/sandboxes/boxes/:name/service-url", "params": [ { "name": "name", "value": "", "type": "path", "description": "Sandbox claim display name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a short-lived JWT for accessing an HTTP service running on a specific port inside a sandbox. Returns a browser_url (sets auth cookie via redirect), a service_url (for use with the X-Langsmith-Sandbox-Service-Token header), the raw token, and its expiry." }, { "info": { "name": "Capture a snapshot from a sandbox", "type": "http" }, "http": { "method": "POST", "url": "/v2/sandboxes/boxes/:name/snapshot", "params": [ { "name": "name", "value": "", "type": "path", "description": "Sandbox claim display name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a snapshot by capturing the current state of a sandbox or promoting an existing checkpoint." }, { "info": { "name": "Start a sandbox", "type": "http" }, "http": { "method": "POST", "url": "/v2/sandboxes/boxes/:name/start", "params": [ { "name": "name", "value": "", "type": "path", "description": "Sandbox claim display name" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Start a stopped or failed sandbox. This endpoint is not idempotent." }, { "info": { "name": "Get sandbox claim status", "type": "http" }, "http": { "method": "GET", "url": "/v2/sandboxes/boxes/:name/status", "params": [ { "name": "name", "value": "", "type": "path", "description": "Sandbox claim display name" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Retrieve the lightweight status of a sandbox claim for polling." }, { "info": { "name": "Stop a sandbox", "type": "http" }, "http": { "method": "POST", "url": "/v2/sandboxes/boxes/:name/stop", "params": [ { "name": "name", "value": "", "type": "path", "description": "Sandbox claim display name" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Stop a ready sandbox. This endpoint is not idempotent; the filesystem is preserved for later restart." }, { "info": { "name": "List snapshots", "type": "http" }, "http": { "method": "GET", "url": "/v2/sandboxes/snapshots", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results" }, { "name": "offset", "value": "", "type": "query", "description": "Pagination offset" }, { "name": "name_contains", "value": "", "type": "query", "description": "Filter by name substring" }, { "name": "status", "value": "", "type": "query", "description": "Filter by status (building, ready, failed, deleting)" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort column (name, status, created_at)" }, { "name": "sort_direction", "value": "", "type": "query", "description": "Sort direction (asc, desc)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List sandbox snapshots for the authenticated tenant, with optional filtering, sorting, and pagination." }, { "info": { "name": "Create a snapshot", "type": "http" }, "http": { "method": "POST", "url": "/v2/sandboxes/snapshots", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a snapshot from a Docker image (async build)." }, { "info": { "name": "Get a snapshot", "type": "http" }, "http": { "method": "GET", "url": "/v2/sandboxes/snapshots/:snapshot_id", "params": [ { "name": "snapshot_id", "value": "", "type": "path", "description": "Snapshot UUID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a sandbox snapshot by ID." }, { "info": { "name": "Delete a snapshot", "type": "http" }, "http": { "method": "DELETE", "url": "/v2/sandboxes/snapshots/:snapshot_id", "params": [ { "name": "snapshot_id", "value": "", "type": "path", "description": "Snapshot UUID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a snapshot by ID. The underlying storage is reclaimed asynchronously." }, { "info": { "name": "Get sandbox resource usage", "type": "http" }, "http": { "method": "GET", "url": "/v2/sandboxes/usage", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get current sandbox resource usage and quota limits for the workspace" } ] }, { "info": { "name": "aws_marketplace", "type": "folder" }, "items": [ { "info": { "name": "AWS Marketplace fulfillment URL registration", "type": "http" }, "http": { "method": "POST", "url": "/aws-marketplace/register", "body": { "type": "multipart-form", "data": [ { "name": "x-amzn-marketplace-token", "type": "text", "value": "" } ] } }, "docs": "Receives the x-amzn-marketplace-token posted by AWS Marketplace when a customer clicks \"Set Up Account\", resolves the customer identity, fetches entitlements, stores both in the DB, and redirects to the thank-you page." } ] }, { "info": { "name": "commits", "type": "folder" }, "items": [ { "info": { "name": "List commits", "type": "http" }, "http": { "method": "GET", "url": "/commits/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path", "description": "Repository owner (tenant handle) or '-' for private repos" }, { "name": "repo", "value": "", "type": "path", "description": "Repository handle" }, { "name": "include_stats", "value": "", "type": "query", "description": "IncludeStats determines whether to compute num_downloads and num_views" }, { "name": "limit", "value": "", "type": "query", "description": "Limit is the pagination limit" }, { "name": "offset", "value": "", "type": "query", "description": "Offset is the pagination offset" }, { "name": "tag", "value": "", "type": "query", "description": "Tag filters commits to only those with a specific tag (e.g. \"production\", \"staging\")" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Lists all commits for a repository with pagination support.\nThis endpoint supports both authenticated and unauthenticated access.\nAuthenticated users can access private repos, while unauthenticated users can only access public repos.\nThe include_stats parameter controls whether download and view statistics are computed (defaults to true)." }, { "info": { "name": "Create a commit", "type": "http" }, "http": { "method": "POST", "url": "/commits/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path", "description": "Repository owner (tenant handle) or '-' for private repos" }, { "name": "repo", "value": "", "type": "path", "description": "Repository handle" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Creates a new commit in a repository.\nRequires authentication and write access to the repository." }, { "info": { "name": "Get a commit", "type": "http" }, "http": { "method": "GET", "url": "/commits/:owner/:repo/:commit", "params": [ { "name": "owner", "value": "", "type": "path", "description": "Repository owner (tenant handle) or '-' for private repos" }, { "name": "repo", "value": "", "type": "path", "description": "Repository handle" }, { "name": "commit", "value": "", "type": "path", "description": "Commit hash, tag, or 'latest'" }, { "name": "get_examples", "value": "", "type": "query" }, { "name": "include", "value": "", "type": "query", "description": "Comma-separated list of optional fields: \"model\", \"is_draft\"" }, { "name": "include_model", "value": "", "type": "query", "description": "Deprecated: use Include instead" }, { "name": "is_view", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Retrieves a specific commit by hash, tag, or \"latest\" for a repository.\nThis endpoint supports both authenticated and unauthenticated access.\nAuthenticated users can access private repos, while unauthenticated users can only access public repos.\nCommit resolution logic:\n- \"latest\" or empty: Get the most recent commit\n- Less than 8 characters: Only check for tags\n- 8 or more characters: Prioritize commit hash over tag, check both" } ] }, { "info": { "name": "experiment-view-overrides", "type": "folder" }, "items": [ { "info": { "name": "Get experiment view override configurations for a dataset", "type": "http" }, "http": { "method": "GET", "url": "/datasets/:dataset_id/experiment-view-overrides", "params": [ { "name": "dataset_id", "value": "\"550e8400-e29b-41d4-a716-446655440000\"", "type": "path", "description": "Dataset ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Retrieves all experiment view override configurations for a specific dataset.\nThis endpoint returns column display overrides including color gradients,\nprecision settings, and column visibility configurations that customize how\nexperiment results are displayed in the UI.\n\nThe response includes all column overrides with their display settings:\n- Column identifiers (must start with inputs, outputs, reference_outputs, feedback, metrics, attachments, or metadata)\n- Color gradients for numeric data v" }, { "info": { "name": "Create new experiment view override configuration for a dataset", "type": "http" }, "http": { "method": "POST", "url": "/datasets/:dataset_id/experiment-view-overrides", "params": [ { "name": "dataset_id", "value": "\"550e8400-e29b-41d4-a716-446655440000\"", "type": "path", "description": "Dataset ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Creates a new experiment view override configuration for a dataset with column display settings.\nThis endpoint allows you to customize how experiment results are displayed by configuring\ncolumn-specific overrides including colors, precision, and visibility.\n\nThe request must include a 'column_overrides' array with at least one override configuration.\nEach column override can specify:\n- column: Required field name (must start with inputs, outputs, reference_outputs, feedback, metrics, attachments" }, { "info": { "name": "Get experiment view override configuration by specific ID", "type": "http" }, "http": { "method": "GET", "url": "/datasets/:dataset_id/experiment-view-overrides/:id", "params": [ { "name": "dataset_id", "value": "\"550e8400-e29b-41d4-a716-446655440000\"", "type": "path", "description": "Dataset ID" }, { "name": "id", "value": "\"123e4567-e89b-12d3-a456-426614174000\"", "type": "path", "description": "Experiment view override ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Retrieves a specific experiment view override configuration using both dataset ID and override ID.\nThis endpoint provides more precise access to experiment view overrides when you have\nthe specific override ID, useful for direct links or cached references.\n\nThe response includes the same column override information as the dataset-level endpoint:\n- Column identifiers with validation prefixes\n- Color gradient settings for numeric data visualization\n- Numeric precision configurations\n- Column visib" }, { "info": { "name": "Update existing experiment view override configuration", "type": "http" }, "http": { "method": "PATCH", "url": "/datasets/:dataset_id/experiment-view-overrides/:id", "params": [ { "name": "dataset_id", "value": "\"550e8400-e29b-41d4-a716-446655440000\"", "type": "path", "description": "Dataset ID" }, { "name": "id", "value": "\"123e4567-e89b-12d3-a456-426614174000\"", "type": "path", "description": "Experiment view override ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Updates an existing experiment view override configuration by completely replacing\nthe column overrides for the specified dataset and override ID.\n\nThis endpoint performs a complete replacement of the column overrides configuration.\nAll existing column overrides will be replaced with the new configuration provided\nin the request body. To add or modify individual columns, include the complete\ndesired configuration in the request.\n\nThe request format is identical to the create endpoint:\n- column_o" }, { "info": { "name": "Delete experiment view override configuration", "type": "http" }, "http": { "method": "DELETE", "url": "/datasets/:dataset_id/experiment-view-overrides/:id", "params": [ { "name": "dataset_id", "value": "\"550e8400-e29b-41d4-a716-446655440000\"", "type": "path", "description": "Dataset ID" }, { "name": "id", "value": "\"123e4567-e89b-12d3-a456-426614174000\"", "type": "path", "description": "Experiment view override ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Permanently deletes an experiment view override configuration for a dataset.\nThis operation removes all column override settings including color gradients,\nprecision configurations, and visibility settings.\n\nAfter deletion, the experiment view will revert to default column display settings.\nThis action cannot be undone - you will need to recreate the override configuration\nif you want to restore custom column settings.\n\nBoth the dataset and override must exist and be accessible by the authentica" } ] }, { "info": { "name": "data_planes", "type": "folder" }, "items": [ { "info": { "name": "List data planes for the current organization", "type": "http" }, "http": { "method": "GET", "url": "/orgs/current/data-planes", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns up to 50 data planes owned by the caller's organization. Sorted status priority (active first), then newest first. Requires BYOC to be enabled for the org." }, { "info": { "name": "Create a new data plane", "type": "http" }, "http": { "method": "POST", "url": "/orgs/current/data-planes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provisions a new data plane shell. Persists the rendered data plane spec, and returns 202 with the data plane in status=requested. Requires BYOC enabled org and org admin." } ] }, { "info": { "name": "tag-transitions", "type": "folder" }, "items": [ { "info": { "name": "Get tag transition history", "type": "http" }, "http": { "method": "GET", "url": "/repos/:owner/:repo/tags/:tag_name/history", "params": [ { "name": "owner", "value": "", "type": "path", "description": "Repository owner (tenant handle)" }, { "name": "repo", "value": "", "type": "path", "description": "Repository handle" }, { "name": "tag_name", "value": "", "type": "path", "description": "Tag name" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the paginated audit log of transitions for a specific\ntag in a repository. Each entry records a commit change\n(from_commit → to_commit) along with who performed it." } ] }, { "info": { "name": "runs", "type": "folder" }, "items": [ { "info": { "name": "Create a Run", "type": "http" }, "http": { "method": "POST", "url": "/runs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Queues a single run for ingestion. The request body must be a JSON-encoded run object that follows the Run schema." }, { "info": { "name": "Ingest Runs (Batch JSON)", "type": "http" }, "http": { "method": "POST", "url": "/runs/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Ingests a batch of runs in a single JSON payload. The payload must have `post` and/or `patch` arrays containing run objects.\nPrefer this endpoint over single‑run ingestion when submitting hundreds of runs, but `/runs/multipart` offers better handling for very large fields and attachments." }, { "info": { "name": "Ingest Runs (Multipart)", "type": "http" }, "http": { "method": "POST", "url": "/runs/multipart", "body": { "type": "multipart-form", "data": [ { "name": "post.{run_id}", "type": "text", "value": "" }, { "name": "patch.{run_id}", "type": "text", "value": "" }, { "name": "post.{run_id}.inputs", "type": "text", "value": "" }, { "name": "patch.{run_id}.outputs", "type": "text", "value": "" }, { "name": "feedback.{run_id}", "type": "text", "value": "" }, { "name": "attachment.{run_id}.{filename}", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Ingests multiple runs, feedback objects, and binary attachments in a single `multipart/form-data` request.\n**Part‑name pattern**: `.[.]` where `event` ∈ {`post`, `patch`, `feedback`, `attachment`}.\n* `post|patch.` – JSON run payload.\n* `post|patch..` – out‑of‑band run data (`inputs`, `outputs`, `events`, `error`, `extra`, `serialized`).\n* `feedback.` – JSON feedback payload (must include `trace_id`).\n* `attachment..` – arbitr" }, { "info": { "name": "Update a Run", "type": "http" }, "http": { "method": "PATCH", "url": "/runs/:run_id", "params": [ { "name": "run_id", "value": "", "type": "path", "description": "Run ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Updates a run identified by its ID. The body should contain only the fields to be changed; unknown fields are ignored." }, { "info": { "name": "Query runs", "type": "http" }, "http": { "method": "POST", "url": "/v2/runs/query", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "**Alpha:** The request and response contract may change;\nReturns a paginated list of runs for the given projects within min/max start_time. Supports filters, cursor pagination, and `selects` to select fields to return." }, { "info": { "name": "Get a single run", "type": "http" }, "http": { "method": "GET", "url": "/v2/runs/:run_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "run_id", "value": "", "type": "path", "description": "Run UUID" }, { "name": "project_id", "value": "", "type": "query", "description": "`project_id` is the UUID of the tracing project that owns the run." }, { "name": "selects", "value": "", "type": "query", "description": "`selects` lists which properties to include on the returned run (repeatable query parameter). Accepts any value of the `RunSelectField` enum. If omitted, only `id` is returned." }, { "name": "start_time", "value": "", "type": "query", "description": "`start_time` is the run's `start_time` (RFC3339 date-time), used together with `project_id` to locate the run." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "**Alpha:** The request and response contract may change;\nReturns one run by ID for the given session and start_time. Use the `selects` query parameter (repeatable) to select fields to return." }, { "info": { "name": "List runs in a trace", "type": "http" }, "http": { "method": "GET", "url": "/v2/traces/:trace_id/runs", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "trace_id", "value": "", "type": "path", "description": "Trace UUID" }, { "name": "filter", "value": "", "type": "query", "description": "`filter` narrows which runs within this trace are returned, using a LangSmith filter expression evaluated against each run. For example: `eq(run_type, \"llm\")` for LLM runs only, or `eq(status, \"error\")` for failed runs.\nSee https://docs.langchain.com/langsmith/trace-query-syntax#filter-query-language for syntax." }, { "name": "max_start_time", "value": "", "type": "query", "description": "`max_start_time` is the inclusive upper bound for run `start_time` (RFC3339 date-time)." }, { "name": "min_start_time", "value": "", "type": "query", "description": "`min_start_time` is the inclusive lower bound for run `start_time` (RFC3339 date-time)." }, { "name": "project_id", "value": "", "type": "query", "description": "`project_id` is the UUID of the tracing project that owns the trace." }, { "name": "selects", "value": "", "type": "query", "description": "`selects` lists which properties to include on each returned run (repeatable query parameter). Accepts any value of the `RunSelectField` enum. If omitted, only `id` is returned." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "**Alpha:** The request and response contract may change;\nReturns runs for a trace ID within min/max start time. Optional `filter`; repeatable `selects` to select fields to return." } ] }, { "info": { "name": "integrations", "type": "folder" }, "items": [ { "info": { "name": "Get Agent Builder integrations settings", "type": "http" }, "http": { "method": "GET", "url": "/v1/agent-builder/integrations", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns default policy, integration overrides, and known integrations for the current workspace." }, { "info": { "name": "Update Agent Builder integrations settings", "type": "http" }, "http": { "method": "PUT", "url": "/v1/agent-builder/integrations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Replaces default policy and integration overrides for the current workspace." } ] }, { "info": { "name": "beacon", "type": "folder" }, "items": [ { "info": { "name": "Submit a self-hosted usage snapshot", "type": "http" }, "http": { "method": "POST", "url": "/v1/beacon/usage-snapshot", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Records aggregate entity counts (workspaces, projects, datasets, active users, etc.)\nfrom a self-hosted deployment. Called daily by installs where PHONE_HOME_ENABLED\nand PHONE_HOME_USAGE_REPORTING_ENABLED are set. Authenticates via license key." } ] }, { "info": { "name": "agents", "type": "folder" }, "items": [ { "info": { "name": "List agents", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/agents", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the agents accessible to the authenticated user." }, { "info": { "name": "Create an agent", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/agents", "params": [ { "name": "include", "value": "", "type": "query", "description": "Comma-separated includes. Supported: files" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Creates an agent with optional initial file tree. Validation runs\nbefore any write; the call is atomic. Default response omits the\nfull file tree — pass ?include=files to echo it back." }, { "info": { "name": "Get an agent", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/agents/:agentID", "params": [ { "name": "agentID", "value": "", "type": "path", "description": "Agent ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the specified agent." }, { "info": { "name": "Update an agent", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/fleet/agents/:agentID", "params": [ { "name": "agentID", "value": "", "type": "path", "description": "Agent ID" }, { "name": "include", "value": "", "type": "query", "description": "Comma-separated includes. Supported: files" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Updates the specified agent. All request fields are optional;\nomitted fields are left unchanged. When a top-level field is\nprovided, it replaces the existing value in full. Entries under\n`files` are created or replaced by path; paths listed in\n`deleted_paths` are removed. The call is atomic: if any entry\nfails validation, no changes are applied. The file tree is\nomitted from the response by default; pass ?include=files to\ninclude it." } ] }, { "info": { "name": "fleet auth", "type": "folder" }, "items": [ { "info": { "name": "List an agent's connections", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/auth-agents/:agent_id/connections", "params": [ { "name": "agent_id", "value": "", "type": "path", "description": "Agent ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Lists the connection tokens granted to a specific agent." }, { "info": { "name": "Grant a connection token to an agent", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/auth-agents/:agent_id/connections", "params": [ { "name": "agent_id", "value": "", "type": "path", "description": "Agent ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Associates an existing connection token with an agent so the agent can act with that token." }, { "info": { "name": "Revoke an agent's connection", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/fleet/auth-agents/:agent_id/connections/:connection_id", "params": [ { "name": "agent_id", "value": "", "type": "path", "description": "Agent ID" }, { "name": "connection_id", "value": "", "type": "path", "description": "Connection ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Removes a single connection from an agent. The underlying token is not revoked." }, { "info": { "name": "List OAuth providers", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/auth-providers", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Lists the OAuth providers configured for your organization. Each provider defines how a third-party service (GitHub, Google, Slack, etc.) authorizes connections." }, { "info": { "name": "Register an OAuth provider", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/auth-providers", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Registers an OAuth provider configuration for your organization. End users can then start authorization sessions against this provider." }, { "info": { "name": "Discover and register an OAuth provider", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/auth-providers/discover", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Auto-discovers an OAuth provider's metadata from an MCP server URL and registers it for your organization in one step." }, { "info": { "name": "Get an OAuth provider", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/auth-providers/:provider_id", "params": [ { "name": "provider_id", "value": "", "type": "path", "description": "Provider ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns a single OAuth provider by ID." }, { "info": { "name": "Update an OAuth provider", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/fleet/auth-providers/:provider_id", "params": [ { "name": "provider_id", "value": "", "type": "path", "description": "Provider ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Updates an OAuth provider's configuration. Sent fields replace the stored values; absent fields are left unchanged." }, { "info": { "name": "Delete an OAuth provider", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/fleet/auth-providers/:provider_id", "params": [ { "name": "provider_id", "value": "", "type": "path", "description": "Provider ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Deletes an OAuth provider. Tokens previously issued for this provider are revoked." }, { "info": { "name": "Start an authorization session", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/auth-sessions", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Initiates an OAuth flow for the caller. If the user is already authorized, returns a completed session that references an existing token. Otherwise, returns a pending session containing a verification URL the user must visit to complete authorization." }, { "info": { "name": "Get an authorization session", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/auth-sessions/:session_id", "params": [ { "name": "session_id", "value": "", "type": "path", "description": "Authorization session ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the current status of an in-flight authorization session. Poll until status is COMPLETED, or the session expires." }, { "info": { "name": "List your connection tokens", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/auth-tokens", "params": [ { "name": "provider_id", "value": "", "type": "query", "description": "Filter by provider ID" }, { "name": "agent_id", "value": "", "type": "query", "description": "Filter by agent ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Lists the active OAuth tokens belonging to the caller. Optionally filter by provider or agent." }, { "info": { "name": "Revoke connection tokens by filter", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/auth-tokens/revoke", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Revokes the caller's connection tokens matching the body filter. Requires at least provider_id; rejects empty filters to prevent accidental mass revocation." }, { "info": { "name": "Update a connection token", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/fleet/auth-tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path", "description": "Token ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Updates a token's metadata such as label or default flag." }, { "info": { "name": "Revoke a connection token", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/fleet/auth-tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path", "description": "Token ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Revokes a single connection token by ID. The user is disconnected from the corresponding service." } ] }, { "info": { "name": "fleet integrations", "type": "folder" }, "items": [ { "info": { "name": "List integrations", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/integrations", "params": [ { "name": "source", "value": "", "type": "query", "description": "Filter by source (e.g. langchain, custom)" }, { "name": "page_size", "value": "", "type": "query", "description": "Items per page (default 20, max 100)" }, { "name": "cursor", "value": "", "type": "query", "description": "Opaque pagination cursor" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns integrations available to the workspace." }, { "info": { "name": "Create a custom integration", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/integrations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Registers a new custom integration. Type is forced to CUSTOM." }, { "info": { "name": "Get an integration", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/integrations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Integration id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get an integration" }, { "info": { "name": "Update a custom integration", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/fleet/integrations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Integration id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Updates mutable fields. URL is immutable." }, { "info": { "name": "Delete a custom integration", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/fleet/integrations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Integration id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Idempotent. Returns 204 whether or not the integration existed." }, { "info": { "name": "Replace integration auth methods", "type": "http" }, "http": { "method": "PUT", "url": "/v1/fleet/integrations/:id/auth-methods", "params": [ { "name": "id", "value": "", "type": "path", "description": "Integration id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Replaces the integration's full list of supported auth methods." } ] }, { "info": { "name": "fleet mcp", "type": "folder" }, "items": [ { "info": { "name": "List MCP servers", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/mcp-servers", "headers": [ { "name": "X-Ls-User-Id", "value": "" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns MCP servers visible to the caller after ABAC filtering. Service-key callers may pass X-Ls-User-Id to resolve per-user OAuth providers." }, { "info": { "name": "Create MCP server", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/mcp-servers", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Registers a new MCP server configuration for the workspace." }, { "info": { "name": "Get MCP server", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/mcp-servers/:mcp_server_id", "params": [ { "name": "mcp_server_id", "value": "", "type": "path", "description": "MCP server ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns a single MCP server by ID." }, { "info": { "name": "Update MCP server", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/fleet/mcp-servers/:mcp_server_id", "params": [ { "name": "mcp_server_id", "value": "", "type": "path", "description": "MCP server ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Partially updates an MCP server. Tool list cache is invalidated on success." }, { "info": { "name": "Delete MCP server", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/fleet/mcp-servers/:mcp_server_id", "params": [ { "name": "mcp_server_id", "value": "", "type": "path", "description": "MCP server ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Deletes an MCP server configuration." }, { "info": { "name": "Register per-user MCP OAuth provider", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/mcp-servers/:mcp_server_id/oauth-provider", "params": [ { "name": "mcp_server_id", "value": "", "type": "path", "description": "MCP server ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Discovers and registers an OAuth provider for a user against an MCP server configured with per-user dynamic client mode. Idempotent when a mapping already exists." }, { "info": { "name": "List MCP tools", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/mcp/tools", "params": [ { "name": "url", "value": "", "type": "query", "description": "MCP server URL to fetch tools from" }, { "name": "oauth_provider_id", "value": "", "type": "query", "description": "OAuth provider ID for token-based auth" }, { "name": "force_refresh", "value": "", "type": "query", "description": "Skip cache and fetch fresh tools" }, { "name": "ls_user_id", "value": "", "type": "query", "description": "User ID override (service-key callers)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns tools from a remote MCP server. Serves cached results when fresh, otherwise fetches from the remote server and caches the response." }, { "info": { "name": "List MCP servers", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/fleet/mcp-servers", "headers": [ { "name": "X-Ls-User-Id", "value": "" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns MCP servers visible to the caller after ABAC filtering. Service-key callers may pass X-Ls-User-Id to resolve per-user OAuth providers." }, { "info": { "name": "Create MCP server", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/fleet/mcp-servers", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Registers a new MCP server configuration for the workspace." }, { "info": { "name": "Get MCP server", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/fleet/mcp-servers/:mcp_server_id", "params": [ { "name": "mcp_server_id", "value": "", "type": "path", "description": "MCP server ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns a single MCP server by ID." }, { "info": { "name": "Update MCP server", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/platform/fleet/mcp-servers/:mcp_server_id", "params": [ { "name": "mcp_server_id", "value": "", "type": "path", "description": "MCP server ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Partially updates an MCP server. Tool list cache is invalidated on success." }, { "info": { "name": "Delete MCP server", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/fleet/mcp-servers/:mcp_server_id", "params": [ { "name": "mcp_server_id", "value": "", "type": "path", "description": "MCP server ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Deletes an MCP server configuration." }, { "info": { "name": "Register per-user MCP OAuth provider", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/fleet/mcp-servers/:mcp_server_id/oauth-provider", "params": [ { "name": "mcp_server_id", "value": "", "type": "path", "description": "MCP server ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Discovers and registers an OAuth provider for a user against an MCP server configured with per-user dynamic client mode. Idempotent when a mapping already exists." } ] }, { "info": { "name": "skills", "type": "folder" }, "items": [ { "info": { "name": "List skills", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/skills", "params": [ { "name": "page_size", "value": "", "type": "query", "description": "Items per page (default 20, max 100)" }, { "name": "cursor", "value": "", "type": "query", "description": "Opaque pagination cursor" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the skills in the caller's workspace, paginated." }, { "info": { "name": "Create a skill", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/skills", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Creates a workspace skill with the supplied file tree. Atomic:\nif the file commit fails, no repo is created." }, { "info": { "name": "Get a skill", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/skills/:skillID", "params": [ { "name": "skillID", "value": "", "type": "path", "description": "Skill ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the specified skill, including its full file tree." }, { "info": { "name": "Replace a skill", "type": "http" }, "http": { "method": "PUT", "url": "/v1/fleet/skills/:skillID", "params": [ { "name": "skillID", "value": "", "type": "path", "description": "Skill ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Replaces the skill's file tree in full. Any file present in the\ncurrent skill but absent from the request body is deleted. The\ncall is atomic; on validation failure no changes are applied." }, { "info": { "name": "Delete a skill", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/fleet/skills/:skillID", "params": [ { "name": "skillID", "value": "", "type": "path", "description": "Skill ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Deletes the skill and all of its files. Idempotent: deleting an\nalready-deleted skill returns 204." } ] }, { "info": { "name": "fleet threads", "type": "folder" }, "items": [ { "info": { "name": "Create thread", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/threads", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Creates a thread record for use with subsequent runs. Request and response bodies are JSON objects describing the thread." }, { "info": { "name": "Search threads", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/threads/search", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Searches threads. Request and response bodies are proxied unchanged to the upstream agent runtime." }, { "info": { "name": "Get thread", "type": "http" }, "http": { "method": "GET", "url": "/v1/fleet/threads/:threadID", "params": [ { "name": "threadID", "value": "", "type": "path", "description": "Thread id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns thread metadata and status for the given thread id." }, { "info": { "name": "Resolve an interrupted thread", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/threads/:threadID/resolve-interrupt", "params": [ { "name": "threadID", "value": "", "type": "path", "description": "Thread id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Completes a human-interrupt pause on the thread without sending new input, allowing execution to continue or finish. On success the response has no body." }, { "info": { "name": "Create thread run", "type": "http" }, "http": { "method": "POST", "url": "/v1/fleet/threads/:threadID/runs", "params": [ { "name": "threadID", "value": "", "type": "path", "description": "Thread id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Starts a run on the thread. The request body must include `assistant_id` (the assistant to execute). Include run inputs and options in the body as supported by this API." } ] }, { "info": { "name": "alert_rules", "type": "folder" }, "items": [ { "info": { "name": "Create an alert rule", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/alerts/:session_id", "params": [ { "name": "session_id", "value": "", "type": "path", "description": "Session ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Creates a new alert rule. The request body must be a JSON-encoded alert rule object that follows the CreateAlertRuleRequest schema." }, { "info": { "name": "Test an alert action to determine if configuration is valid", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/alerts/:session_id/test", "params": [ { "name": "session_id", "value": "", "type": "path", "description": "Session ID" }, { "name": "alert_rule_id", "value": "", "type": "path", "description": "Alert rule ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Tests an alert action which will fire a notification to all configured recipients if the configuration is valid." }, { "info": { "name": "Get an alert rule", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/alerts/:session_id/:alert_rule_id", "params": [ { "name": "session_id", "value": "", "type": "path", "description": "Session ID" }, { "name": "alert_rule_id", "value": "", "type": "path", "description": "Alert rule ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Gets an alert rule." }, { "info": { "name": "Update an alert rule", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/platform/alerts/:session_id/:alert_rule_id", "params": [ { "name": "session_id", "value": "", "type": "path", "description": "Session ID" }, { "name": "alert_rule_id", "value": "", "type": "path", "description": "Alert rule ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Updates an alert rule." }, { "info": { "name": "Delete an alert rule", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/alerts/:session_id/:alert_rule_id", "params": [ { "name": "session_id", "value": "", "type": "path", "description": "Session ID" }, { "name": "alert_rule_id", "value": "", "type": "path", "description": "Alert rule ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Deletes an alert rule" } ] }, { "info": { "name": "annotation_queues", "type": "folder" }, "items": [ { "info": { "name": "Add a reviewer to an annotation queue", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/annotation-queues/:queue_id/reviewers", "params": [ { "name": "queue_id", "value": "", "type": "path", "description": "Queue ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Assigns a single identity as a reviewer for the queue. Idempotent." }, { "info": { "name": "Remove a reviewer from an annotation queue", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/annotation-queues/:queue_id/reviewers/:identity_id", "params": [ { "name": "queue_id", "value": "", "type": "path", "description": "Queue ID" }, { "name": "identity_id", "value": "", "type": "path", "description": "Identity ID of the reviewer to remove" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Unassigns an identity as a reviewer for the queue. Idempotent." } ] }, { "info": { "name": "evaluators", "type": "folder" }, "items": [ { "info": { "name": "List evaluators", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/evaluators", "params": [ { "name": "type", "value": "", "type": "query", "description": "Filter by evaluator type" }, { "name": "name_contains", "value": "", "type": "query", "description": "Filter by name substring (also searches creator names)" }, { "name": "tag_value_id", "value": "", "type": "query", "description": "Filter by tag value IDs" }, { "name": "feedback_key", "value": "", "type": "query", "description": "Filter by feedback key" }, { "name": "resource_id", "value": "", "type": "query", "description": "Filter by resource IDs" }, { "name": "sort_by", "value": "", "type": "query", "description": "Field to sort by" }, { "name": "sort_by_desc", "value": "", "type": "query", "description": "Sort in descending order" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results (1-100)" }, { "name": "offset", "value": "", "type": "query", "description": "Offset for pagination" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List evaluators for the current workspace, with optional filtering by type, name, tag, feedback key, or resource ID." }, { "info": { "name": "Create evaluator", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/evaluators", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new LLM or code evaluator for the current workspace." }, { "info": { "name": "Bulk delete evaluators", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/evaluators", "params": [ { "name": "evaluator_ids", "value": "", "type": "query", "description": "Evaluator IDs to delete" }, { "name": "delete_run_rules", "value": "", "type": "query", "description": "When true, delete all run rules for this evaluator before deleting the evaluator" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete multiple evaluators by their IDs. Returns per-item success/failure." }, { "info": { "name": "Get evaluator", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/evaluators/:evaluator_id", "params": [ { "name": "evaluator_id", "value": "", "type": "path", "description": "Evaluator ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Retrieve a single evaluator by its ID." }, { "info": { "name": "Update evaluator", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/platform/evaluators/:evaluator_id", "params": [ { "name": "evaluator_id", "value": "", "type": "path", "description": "Evaluator ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update an existing evaluator's name, LLM configuration, or code configuration." }, { "info": { "name": "Delete evaluator", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/evaluators/:evaluator_id", "params": [ { "name": "evaluator_id", "value": "", "type": "path", "description": "Evaluator ID" }, { "name": "delete_run_rules", "value": "", "type": "query", "description": "When true, delete all run rules for this evaluator before deleting the evaluator" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete an evaluator. When delete_run_rules is true, all run rules referencing this evaluator are deleted first (same tenant). Associated llm_evaluators and code_evaluators rows are removed by foreign-key cascade when the evaluator row is deleted." } ] }, { "info": { "name": "features", "type": "folder" }, "items": [ { "info": { "name": "List feature configurations", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/features", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns a consolidated view of default models and disabled models per feature for the workspace." }, { "info": { "name": "Set default model for a feature", "type": "http" }, "http": { "method": "PUT", "url": "/v1/platform/features/:feature/default-model", "params": [ { "name": "feature", "value": "", "type": "path", "description": "Feature name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Sets or replaces the default model for a feature in the workspace." }, { "info": { "name": "Delete default model for a feature", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/features/:feature/default-model", "params": [ { "name": "feature", "value": "", "type": "path", "description": "Feature name" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Removes the default model for a feature in the workspace." }, { "info": { "name": "Disable a model for a feature", "type": "http" }, "http": { "method": "PUT", "url": "/v1/platform/features/:feature/disabled-models", "params": [ { "name": "feature", "value": "", "type": "path", "description": "Feature name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Adds a model to the disabled list for a feature in the workspace." }, { "info": { "name": "Re-enable a disabled model for a feature", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/features/:feature/disabled-models/:model", "params": [ { "name": "feature", "value": "", "type": "path", "description": "Feature name" }, { "name": "model", "value": "", "type": "path", "description": "Model name (URL-encoded)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Removes a model from the disabled list for a feature in the workspace." } ] }, { "info": { "name": "fleet_webhooks", "type": "folder" }, "items": [ { "info": { "name": "Run a fleet webhook", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/fleet-webhooks/:webhook_id/run", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "Webhook UUID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Sends the request payload to the webhook's stored URL and returns the upstream response in a JSON envelope." } ] }, { "info": { "name": "fleet github-app", "type": "folder" }, "items": [ { "info": { "name": "Get GitHub OAuth authorization link", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/fleet/providers/github-app/auth", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Generate a GitHub OAuth link for the current user to connect their GitHub account." }, { "info": { "name": "Get GitHub user connection status", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/fleet/providers/github-app/connection", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Return the current user's GitHub connection status and metadata." }, { "info": { "name": "Update GitHub user connection", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/platform/fleet/providers/github-app/connection", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update the actor preference for the current user's GitHub connection." }, { "info": { "name": "Delete GitHub user connection", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/fleet/providers/github-app/connection", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Remove the current user's GitHub connection and all linked installations." }, { "info": { "name": "Get GitHub App install link", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/fleet/providers/github-app/install", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Generate a link to install the GitHub App for the current organization." }, { "info": { "name": "List GitHub App installations", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/fleet/providers/github-app/installations", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Return GitHub App installations linked to the current user from\nour database. This is a cache — it does not hit the GitHub API.\nUse POST /installations/refresh to force a fresh sync from GitHub." }, { "info": { "name": "Refresh GitHub App installations", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/fleet/providers/github-app/installations/refresh", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Trigger a live sync with GitHub for the current user's GitHub App\ninstallations. Upserts new installations, deletes stale ones, and\nreturns the refreshed list. Requires an existing GitHub connection." }, { "info": { "name": "Delete a GitHub App installation", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/fleet/providers/github-app/installations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Installation ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Remove a GitHub App installation link for the current user." }, { "info": { "name": "List repositories for a GitHub App installation", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/fleet/providers/github-app/installations/:id/repos", "params": [ { "name": "id", "value": "", "type": "path", "description": "Installation ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Return repositories accessible to the specified GitHub App installation." }, { "info": { "name": "Request a GitHub access token", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/fleet/providers/github-app/tokens", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Return a short-lived GitHub access token scoped to the given repository." }, { "info": { "name": "Handle GitHub App webhook events", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/fleet/providers/github-app/webhooks" }, "docs": "Process GitHub App webhooks (installation lifecycle, installation_repositories). GitHub may deliver the same event more than once; handling re-applies the current repository-selection state and is safe to repeat." } ] }, { "info": { "name": "fleet usage", "type": "folder" }, "items": [ { "info": { "name": "List fleet agents with usage", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/fleet/usage/agents", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Max results (max 100)" }, { "name": "start_time", "value": "", "type": "query", "description": "Start of cost window (ISO8601)" }, { "name": "end_time", "value": "", "type": "query", "description": "End of cost window (ISO8601)" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort field (cost, runs, last_used, first_used)" }, { "name": "sort_order", "value": "", "type": "query", "description": "Sort direction (asc, desc)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the top agents in the workspace with cost data for the given time window. Defaults to sorting by cost descending; pass sort_by and sort_order to change. Data is sourced entirely from ClickHouse run metadata." }, { "info": { "name": "List fleet models with usage", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/fleet/usage/models", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Max results (max 100)" }, { "name": "start_time", "value": "", "type": "query", "description": "Start of window (ISO8601)" }, { "name": "end_time", "value": "", "type": "query", "description": "End of window (ISO8601)" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort field (cost, runs, last_used)" }, { "name": "sort_order", "value": "", "type": "query", "description": "Sort direction (asc, desc)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the top models used in the workspace with aggregated cost and distinct run counts for the given time window. Defaults to sorting by cost descending; pass sort_by and sort_order to change." }, { "info": { "name": "List fleet tools with usage", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/fleet/usage/tools", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Max results (max 100)" }, { "name": "start_time", "value": "", "type": "query", "description": "Start of window (ISO8601)" }, { "name": "end_time", "value": "", "type": "query", "description": "End of window (ISO8601)" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort field (runs, avg_latency_ms, agent_count, last_used)" }, { "name": "sort_order", "value": "", "type": "query", "description": "Sort direction (asc, desc)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the top tools in the workspace with run counts, latency, and agent counts for the given time window. Defaults to sorting by runs descending; pass sort_by and sort_order to change." }, { "info": { "name": "List fleet users with usage", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/fleet/usage/users", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Max results (max 100)" }, { "name": "start_time", "value": "", "type": "query", "description": "Start of cost window (ISO8601)" }, { "name": "end_time", "value": "", "type": "query", "description": "End of cost window (ISO8601)" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort field (cost, runs, agent_count, last_used, first_used)" }, { "name": "sort_order", "value": "", "type": "query", "description": "Sort direction (asc, desc)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the top users with aggregated cost data for the given time window. Defaults to sorting by cost descending; pass sort_by and sort_order to change." } ] }, { "info": { "name": "gateway-policies", "type": "folder" }, "items": [ { "info": { "name": "List gateway policies", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/gateway-policies", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns every non-deleted gateway policy in the calling\norganization, sorted by `priority` ASC then `created_at` DESC.\nEach spend-cap row includes `current_spend_usd` — the spend\naccumulated in the policy's active window. This is the\nprimary cost-tracking surface for the LLM Gateway: dashboards\nand alerts read per-policy spend off this response. Disabled\nspend-cap policies still surface `current_spend_usd` so\nadmins can see what would have been enforced." }, { "info": { "name": "Create a gateway policy", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/gateway-policies", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Creates a `spend_cap`, `default_spend_cap`, or `guard` policy\nfor the calling organization. If a non-deleted policy in the\nsame family already exists with set-equal `subject_matchers`,\nthe existing row is upserted (mutable fields overwritten,\n`id` preserved) — including takeover of materialized\ndefault-spend-cap children." }, { "info": { "name": "Get a gateway policy", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/gateway-policies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Policy ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns a single gateway policy by id. Spend-cap rows include\n`current_spend_usd` for the active window so callers can read\nper-policy cost without a separate endpoint." }, { "info": { "name": "Update a gateway policy", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/platform/gateway-policies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Policy ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Partially updates a gateway policy. Only fields present in the\nrequest body are applied; absent fields are left unchanged.\nEditing a `default_spend_cap` cascades the new\nconfig/action/enabled/priority onto every attached child so\nthe template stays the source of truth across rollouts." }, { "info": { "name": "Delete a gateway policy", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/gateway-policies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Policy ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Soft-deletes a gateway policy. Deleting a `default_spend_cap`\ncascade-soft-deletes every attached child in the same\ntransaction, so the admin wipes a template and its rollouts\nin a single call. Spend counters for the deleted policy are\nleft to expire naturally — the policy id is never reused,\nso any residual counter is unreachable." } ] }, { "info": { "name": "directories", "type": "folder" }, "items": [ { "info": { "name": "Get directory contents", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/hub/repos/:owner/:repo/directories", "params": [ { "name": "owner", "value": "", "type": "path", "description": "Repository owner handle or '-' for current tenant" }, { "name": "repo", "value": "", "type": "path", "description": "Repository handle" }, { "name": "commit", "value": "", "type": "query", "description": "Commit hash/tag to resolve (defaults to latest)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Resolves the flattened file tree for an agent or skill repository at a specific commit, tag, or latest." }, { "info": { "name": "Delete directory repository", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/hub/repos/:owner/:repo/directories", "params": [ { "name": "owner", "value": "", "type": "path", "description": "Repository owner handle or '-' for current tenant" }, { "name": "repo", "value": "", "type": "path", "description": "Repository handle" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Deletes an agent or skill repository and its owned child file repositories." }, { "info": { "name": "Create directory commit", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/hub/repos/:owner/:repo/directories/commits", "params": [ { "name": "owner", "value": "", "type": "path", "description": "Repository owner handle or '-' for current tenant" }, { "name": "repo", "value": "", "type": "path", "description": "Repository handle" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Creates a new directory commit for an agent or skill repository by applying file/link create, update, and delete operations." } ] }, { "info": { "name": "mcp_vendors", "type": "folder" }, "items": [ { "info": { "name": "List MCP vendors", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/mcp-vendors", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the catalog of available MCP vendors." }, { "info": { "name": "Get MCP vendor", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/mcp-vendors/:vendor_slug", "params": [ { "name": "vendor_slug", "value": "", "type": "path", "description": "Vendor slug (e.g. arcade)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns vendor metadata and current settings." }, { "info": { "name": "Get vendor account", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/mcp-vendors/:vendor_slug/account", "params": [ { "name": "vendor_slug", "value": "", "type": "path", "description": "Vendor slug (e.g. arcade)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Resolves OAuth token and returns the vendor's account info." }, { "info": { "name": "List MCP servers for a vendor", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/mcp-vendors/:vendor_slug/mcp-servers", "params": [ { "name": "vendor_slug", "value": "", "type": "path", "description": "Vendor slug (e.g. arcade)" }, { "name": "limit", "value": "", "type": "query", "description": "Max items to return (default 100)" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip (default 0)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the MCP gateways from the vendor for the workspace's configured org/project." }, { "info": { "name": "Get vendor settings", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/mcp-vendors/:vendor_slug/settings", "params": [ { "name": "vendor_slug", "value": "", "type": "path", "description": "Vendor slug (e.g. arcade)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the current vendor-specific settings." }, { "info": { "name": "Create vendor settings", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/mcp-vendors/:vendor_slug/settings", "params": [ { "name": "vendor_slug", "value": "", "type": "path", "description": "Vendor slug (e.g. arcade)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Initializes vendor settings." }, { "info": { "name": "Replace vendor settings", "type": "http" }, "http": { "method": "PUT", "url": "/v1/platform/mcp-vendors/:vendor_slug/settings", "params": [ { "name": "vendor_slug", "value": "", "type": "path", "description": "Vendor slug (e.g. arcade)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Replaces vendor settings." }, { "info": { "name": "Delete vendor settings", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/mcp-vendors/:vendor_slug/settings", "params": [ { "name": "vendor_slug", "value": "", "type": "path", "description": "Vendor slug (e.g. arcade)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Removes vendor settings." }, { "info": { "name": "List tools for a vendor", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/mcp-vendors/:vendor_slug/tools", "params": [ { "name": "vendor_slug", "value": "", "type": "path", "description": "Vendor slug (e.g. arcade)" }, { "name": "limit", "value": "", "type": "query", "description": "Max tools to return (default 50)" }, { "name": "offset", "value": "", "type": "query", "description": "Number of tools to skip (default 0)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns the tool catalog for this vendor." } ] }, { "info": { "name": "nps", "type": "folder" }, "items": [ { "info": { "name": "Submit an NPS response", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/nps/response", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Records the authenticated user's NPS score and optional comment." } ] }, { "info": { "name": "backfills", "type": "folder" }, "items": [ { "info": { "name": "Restart a backfill job", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/ops/backfills/restart", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Deletes the backfill job record, causing the backfill to restart from the beginning on the next cron tick. Requires instance admin access." } ] }, { "info": { "name": "access_policies", "type": "folder" }, "items": [ { "info": { "name": "List access policies", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/orgs/current/access-policies", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Lists all access policies for the organization." }, { "info": { "name": "Create an access policy", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/orgs/current/access-policies", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Creates a new access policy." }, { "info": { "name": "Attach access policies to a role", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/orgs/current/access-policies/roles/:role_id/access-policies", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "Role ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Attaches one or more access policies to a specific role. The request body must contain an array of access policy IDs." }, { "info": { "name": "Get an access policy", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/orgs/current/access-policies/:access_policy_id", "params": [ { "name": "access_policy_id", "value": "", "type": "path", "description": "Access Policy ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Gets a specific access policy by ID." }, { "info": { "name": "Delete an access policy", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/orgs/current/access-policies/:access_policy_id", "params": [ { "name": "access_policy_id", "value": "", "type": "path", "description": "Access Policy ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Deletes a specific access policy by ID." } ] }, { "info": { "name": "Organizations", "type": "folder" }, "items": [ { "info": { "name": "Get current organization info", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/orgs/current/info", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns organization info for the authenticated user's current organization." } ] }, { "info": { "name": "SCIM Tokens", "type": "folder" }, "items": [ { "info": { "name": "List SCIM tokens", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/orgs/current/scim/tokens", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List all SCIM bearer tokens for the current organization. The full token values are not returned." }, { "info": { "name": "Create a SCIM token", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/orgs/current/scim/tokens", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new SCIM bearer token for the current organization. The full token value is only returned once upon creation." }, { "info": { "name": "Get a SCIM token", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/orgs/current/scim/tokens/:scim_token_id", "params": [ { "name": "scim_token_id", "value": "", "type": "path", "description": "SCIM Token ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Retrieve a specific SCIM token by ID for the current organization. The full token value is not returned." }, { "info": { "name": "Update a SCIM token", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/platform/orgs/current/scim/tokens/:scim_token_id", "params": [ { "name": "scim_token_id", "value": "", "type": "path", "description": "SCIM Token ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update the description of an existing SCIM token for the current organization." }, { "info": { "name": "Delete a SCIM token", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/orgs/current/scim/tokens/:scim_token_id", "params": [ { "name": "scim_token_id", "value": "", "type": "path", "description": "SCIM Token ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a SCIM bearer token from the current organization." } ] }, { "info": { "name": "sessions", "type": "folder" }, "items": [ { "info": { "name": "List agent versions for a project", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/sessions/:sessionID/agent-versions", "params": [ { "name": "sessionID", "value": "", "type": "path", "description": "Tracing project (session) UUID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns all agent versions (commit SHAs) seen in the given tracing project, ordered by first_seen_at descending." } ] }, { "info": { "name": "tools", "type": "folder" }, "items": [ { "info": { "name": "List tools", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/tools", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of tools to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of tools to skip" }, { "name": "query", "value": "", "type": "query", "description": "Search query to filter tools by name or description" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns a paginated list of tools in the workspace." }, { "info": { "name": "Create a tool", "type": "http" }, "http": { "method": "POST", "url": "/v1/platform/tools", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Creates a new tool in the workspace." }, { "info": { "name": "Get a tool by ID", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/tools/id/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Tool UUID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns a tool identified by its UUID." }, { "info": { "name": "Update a tool by ID", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/platform/tools/id/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Tool UUID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Updates an existing tool identified by its UUID." }, { "info": { "name": "Delete a tool by ID", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/tools/id/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Tool UUID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Deletes a tool identified by its UUID." }, { "info": { "name": "Get a tool by handle", "type": "http" }, "http": { "method": "GET", "url": "/v1/platform/tools/:handle", "params": [ { "name": "handle", "value": "", "type": "path", "description": "Tool handle" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Returns a tool identified by its handle." }, { "info": { "name": "Update a tool by handle", "type": "http" }, "http": { "method": "PATCH", "url": "/v1/platform/tools/:handle", "params": [ { "name": "handle", "value": "", "type": "path", "description": "Tool handle" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Updates an existing tool identified by its handle." }, { "info": { "name": "Delete a tool by handle", "type": "http" }, "http": { "method": "DELETE", "url": "/v1/platform/tools/:handle", "params": [ { "name": "handle", "value": "", "type": "path", "description": "Tool handle" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Deletes a tool identified by its handle." } ] }, { "info": { "name": "sandboxes-internal", "type": "folder" }, "items": [ { "info": { "name": "Internal: start a stopped sandbox (service-to-service)", "type": "http" }, "http": { "method": "POST", "url": "/v2/sandboxes/internal/start/:name", "headers": [ { "name": "X-Tenant-Id", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "Sandbox display name or route name (sb-)" } ] }, "docs": "Called by the sandbox-router to wake stopped sandboxes. Blocks until the sandbox is ready or times out. The name parameter accepts either the display name or route name (sb-)." } ] }, { "info": { "name": "threads", "type": "folder" }, "items": [ { "info": { "name": "Query Threads", "type": "http" }, "http": { "method": "POST", "url": "/v2/threads/query", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "**Alpha:** The request and response contract may change;\nQuery threads within a project (session), with cursor-based pagination.\nReturns threads matching the given time range and optional filter." }, { "info": { "name": "Query Thread Traces", "type": "http" }, "http": { "method": "GET", "url": "/v2/threads/:thread_id/traces", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "Thread ID" }, { "name": "cursor", "value": "", "type": "query", "description": "`cursor` is the opaque string from a previous response's `next_cursor`. Omit on the first request; pass the returned cursor to fetch the next page." }, { "name": "filter", "value": "", "type": "query", "description": "`filter` narrows which traces are returned for this thread, using a LangSmith filter expression evaluated against each root trace run.\nFor example: eq(status, \"success\") or has(tags, \"production\").\nSee https://docs.langchain.com/langsmith/trace-query-syntax#filter-query-language for syntax." }, { "name": "page_size", "value": "20", "type": "query", "description": "`page_size` is the maximum number of traces to return in this response. Defaults to 20 when omitted; must be between 1 and 100 inclusive when set." }, { "name": "project_id", "value": "", "type": "query", "description": "`project_id` is the tracing project UUID (required)." }, { "name": "selects", "value": "NAME,START_TIME", "type": "query", "description": "`selects` lists which properties to include on each returned trace (repeatable query parameter). Accepts any value of the `ThreadTraceSelectField` enum. Properties not listed are omitted from each trace object; `trace_id` is always returned." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "**Alpha:** The request and response contract may change;\nRetrieve all traces belonging to a specific thread within a project." } ] }, { "info": { "name": "TTL Settings", "type": "folder" }, "items": [ { "info": { "name": "Get workspace TTL settings", "type": "http" }, "http": { "method": "GET", "url": "/workspaces/current/ttl-settings", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get the longlived trace TTL settings for a workspace" }, { "info": { "name": "Update workspace TTL settings", "type": "http" }, "http": { "method": "PUT", "url": "/workspaces/current/ttl-settings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update the longlived trace TTL for a workspace." } ] } ], "bundled": true }