{ "info": { "title": "Robocorp Control Room API", "description": "Robocorp Control Room API", "version": "1.0" }, "openapi": "3.0.0", "tags": [ { "name": "asset", "description": "Asset Storage" }, { "name": "assistant", "description": "Assistant" }, { "name": "process", "description": "Process" }, { "name": "process-run", "description": "Process Run" }, { "name": "step-run", "description": "Step Run" }, { "name": "task-package", "description": "Task Package" }, { "name": "vault", "description": "Vault" }, { "name": "webhooks", "description": "Webhooks" }, { "name": "work-item", "description": "Work Item" }, { "name": "worker", "description": "Worker" }, { "name": "worker-group", "description": "Worker Group" }, { "name": "workspace", "description": "Workspace" } ], "components": { "securitySchemes": { "API Key with permissions": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "A Control Room API key with the necessary permission(s) granted.\nPrefix the API key value retrieved from Control Room with RC-WSKEY.\n" }, "Access Credentials": { "type": "accessCredentials", "name": "Authorization", "in": "header", "description": "Access credentials are tied to your user account and grant the same privileges as your user account.\n" } }, "schemas": { "ActionPackage": { "type": "object", "required": [ "organization", "name", "releases" ], "properties": { "organization": { "$ref": "#/components/schemas/Organization" }, "name": { "type": "string" }, "releases": { "type": "array", "items": { "$ref": "#/components/schemas/ActionPackageRelease" } } } }, "Organization": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "ActionPackageRelease": { "type": "object", "required": [ "id", "version", "updated_at" ], "properties": { "id": { "type": "string" }, "version": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" } } }, "CreateZipTaskPackage": { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "zip" ] } } }, "CreatePublicGitTaskPackage": { "type": "object", "required": [ "name", "type", "configuration" ], "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "public_git" ] }, "configuration": { "type": "object", "required": [ "repository" ], "properties": { "repository": { "type": "string" } } } } }, "CreateGitIntegrationTaskPackage": { "type": "object", "required": [ "name", "type", "configuration" ], "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "github", "gitlab" ] }, "configuration": { "oneOf": [ { "type": "object", "required": [ "mode", "repository", "branch", "automatic_deployment" ], "properties": { "mode": { "type": "string", "enum": [ "attached" ], "description": "Task package can be updated based on latest changes." }, "repository": { "type": "string", "description": "An existing git repository." }, "branch": { "type": "string", "description": "An existing git branch on the repository." }, "automatic_deployment": { "type": "boolean", "description": "If enabled, any changes are automatically pulled. If disabled, the task package will point to the head commit at the time of the update." } } }, { "type": "object", "required": [ "mode", "repository", "reference" ], "properties": { "mode": { "type": "string", "enum": [ "detached" ], "description": "Task package will point only to specified reference." }, "repository": { "type": "string", "description": "An existing git repository." }, "reference": { "type": "string", "description": "An existing commit hash, tag or branch on the repository." } } } ] } } }, "EmailTriggerConfig": { "type": "object", "required": [ "type", "configuration" ], "properties": { "type": { "type": "string", "enum": [ "email" ] }, "configuration": { "type": "object", "required": [ "trigger_process_run_automatically" ], "properties": { "trigger_process_run_automatically": { "type": "boolean" } } } } }, "CloudWorker": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "cloud" ] } } }, "NonCloudWorker": { "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "self_hosted", "environment_group", "on_demand" ] }, "id": { "type": "string" } } }, "CronScheduleConfig": { "type": "object", "required": [ "type", "start_with_input_items", "configuration" ], "properties": { "type": { "type": "string", "enum": [ "cron" ] }, "start_with_input_items": { "description": "If true, no run will be started if the input is empty. Default work item settings will be ignored. If false, a run will be started with the input work items instead of the default work item.", "type": "boolean" }, "configuration": { "required": [ "timezone", "expression" ], "properties": { "timezone": { "description": "Timezone in TZ format, e.g. 'Europe/Helsinki' or 'UTC'", "type": "string" }, "expression": { "description": "Must be a valid cron expression", "type": "string" } } } } }, "IntervalScheduleConfig": { "type": "object", "required": [ "type", "start_with_input_items", "configuration" ], "properties": { "type": { "type": "string", "enum": [ "interval" ] }, "start_with_input_items": { "description": "If true, no run will be started if the input is empty. Default work item settings will be ignored.", "type": "boolean" }, "configuration": { "required": [ "interval" ], "properties": { "interval": { "type": "string" } } } } }, "WeekdayScheduleConfig": { "type": "object", "required": [ "type", "start_with_input_items", "configuration" ], "properties": { "type": { "type": "string", "enum": [ "weekday" ] }, "start_with_input_items": { "description": "If true, no run will be started if the input is empty. Default work item settings will be ignored.", "type": "boolean" }, "configuration": { "required": [ "hour", "minute", "timezone", "days_of_week" ], "properties": { "timezone": { "description": "Timezone in TZ format, e.g. 'Europe/Helsinki' or 'UTC'", "type": "string" }, "hour": { "description": "0 to 23", "type": "number" }, "minute": { "description": "0 to 59", "type": "number" }, "days_of_week": { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } } } } } }, "EmailNotificationConfig": { "required": [ "type", "enabled_events", "configuration" ], "properties": { "type": { "type": "string", "enum": [ "email" ] }, "enabled_events": { "type": "array", "items": { "type": "string", "enum": [ "process_run.completed", "process_run.unresolved" ] } }, "configuration": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string" } } } } }, "WebhookNotificationConfig": { "required": [ "type", "enabled_events", "configuration" ], "properties": { "type": { "type": "string", "enum": [ "webhook" ] }, "enabled_events": { "type": "array", "items": { "type": "string", "enum": [ "process_run.completed", "process_run.unresolved", "process_run.started" ] } }, "configuration": { "type": "object", "required": [ "endpoint" ], "properties": { "endpoint": { "type": "string" } } } } }, "SlackNotificationConfig": { "required": [ "type", "enabled_events", "configuration" ], "properties": { "type": { "type": "string", "enum": [ "slack" ] }, "enabled_events": { "type": "array", "items": { "type": "string", "enum": [ "process_run.completed", "process_run.unresolved" ] } }, "configuration": { "type": "object", "required": [ "slack_channel" ], "properties": { "slack_channel": { "description": "ID of the slack channel to send notifications to. Must belong to the linked slack workspace.", "type": "string" } } } } }, "WorkspaceResource": { "type": "object", "required": [ "id", "name", "organization", "url" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "url": { "type": "string" } } }, "WorkerResource": { "type": "object", "required": [ "id", "name", "state" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string", "enum": [ "offline", "idle", "busy" ] } } }, "WorkerGroupResource": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "LinkTokenResource": { "type": "object", "required": [ "id", "expires_at", "link_token" ], "properties": { "id": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "link_token": { "type": "string" } } }, "WorkerGroupLinkTokenResource": { "type": "object", "required": [ "id", "name", "expires_at", "worker_group" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "worker_group": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } } } }, "ProcessRunOutputResource": { "type": "object", "required": [ "id", "created_at", "process", "process_run", "payload", "files" ], "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "process": { "type": "object", "$ref": "#/components/schemas/ProcessReferenceResource" }, "process_run": { "type": "object", "$ref": "#/components/schemas/ProcessRunReferenceResource" }, "payload": { "$ref": "#/components/schemas/WorkItemPayload" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/WorkItemFile" } } } }, "WorkspaceReferenceResource": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "ProcessReferenceResource": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "ProcessRunReferenceResource": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "ProcessRunResource": { "type": "object", "required": [ "id", "state", "created_at", "started_at", "ended_at", "started_by", "process", "duration" ], "properties": { "id": { "type": "string" }, "state": { "type": "string", "enum": [ "new", "in_progress", "completed", "unresolved", "stopping" ] }, "created_at": { "type": "string", "format": "date-time" }, "started_at": { "type": "string", "nullable": true, "format": "date-time" }, "ended_at": { "type": "string", "nullable": true, "format": "date-time" }, "process": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "started_by": { "type": "object", "required": [ "type", "details" ], "properties": { "type": { "type": "string", "enum": [ "api", "user", "schedule", "email" ] }, "details": { "type": "object", "description": "Details are only available when the process run was started by a `user`", "nullable": true, "required": [ "id", "first_name", "last_name" ], "properties": { "id": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } } } } }, "duration": { "type": "number", "nullable": true, "description": "Process run duration in seconds" } } }, "ActivityResource": { "type": "object", "properties": { "id": { "type": "string" } } }, "ActivityRunResource": { "type": "object", "properties": { "id": { "type": "string" } } }, "WebhookResource": { "type": "object", "required": [ "id", "process", "enabled_events", "secret", "endpoint" ], "properties": { "id": { "type": "string" }, "process": { "nullable": true, "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "enabled_events": { "$ref": "#/components/schemas/WebhookEnabledEvents" }, "secret": { "type": "string" }, "endpoint": { "type": "string", "format": "url" } } }, "WebhookEnabledEvents": { "type": "array", "items": { "type": "string" } }, "ProcessWebhookEnabledEvents": { "type": "array", "items": { "type": "string", "enum": [ "process_run.started", "process_run.completed", "process_run.unresolved" ] } }, "ProcessWebhookPayload": { "type": "object", "required": [ "endpoint", "enabled_events", "process" ], "properties": { "endpoint": { "type": "string", "format": "url" }, "enabled_events": { "$ref": "#/components/schemas/ProcessWebhookEnabledEvents" }, "process": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } }, "WorkItemState": { "type": "string", "enum": [ "new", "pending", "in_progress", "failed", "done" ] }, "WorkItemException": { "type": "object", "nullable": true, "required": [ "code", "type", "message" ], "properties": { "code": { "type": "string" }, "type": { "type": "string", "enum": [ "application", "business", "orchestrator", "unspecified" ] }, "message": { "type": "string" } } }, "WorkItemPayload": { "nullable": true, "$ref": "#/components/schemas/anyValidJson" }, "WorkItemFile": { "type": "object", "required": [ "id", "size", "name", "download" ], "properties": { "id": { "type": "string" }, "size": { "type": "number", "description": "File size in bytes" }, "name": { "type": "string", "description": "File name" }, "download": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "File download URL. The URL is valid for **one hour**." } } } } }, "WorkItemWithoutDataResource": { "type": "object", "required": [ "id", "created_at", "state", "state_updated_at", "process", "process_run", "exception", "step", "step_run" ], "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "state": { "$ref": "#/components/schemas/WorkItemState" }, "state_updated_at": { "type": "string", "nullable": true, "format": "date-time" }, "process": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "process_run": { "type": "object", "nullable": true, "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "step": { "type": "object", "nullable": true, "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "step_run": { "type": "object", "nullable": true, "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "exception": { "$ref": "#/components/schemas/WorkItemException" } } }, "WorkItemResource": { "type": "object", "required": [ "id", "created_at", "state", "state_updated_at", "process", "process_run", "exception", "step", "step_run", "payload", "files" ], "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "state": { "$ref": "#/components/schemas/WorkItemState" }, "state_updated_at": { "type": "string", "nullable": true, "format": "date-time" }, "process": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "process_run": { "type": "object", "nullable": true, "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "step": { "type": "object", "nullable": true, "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "step_run": { "type": "object", "nullable": true, "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "payload": { "$ref": "#/components/schemas/WorkItemPayload" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/WorkItemFile" } }, "exception": { "$ref": "#/components/schemas/WorkItemException" } } }, "ProcessRunCallback": { "type": "object", "required": [ "url", "secret", "callback_events" ], "properties": { "url": { "type": "string" }, "secret": { "type": "string" }, "callback_events": { "type": "array", "items": { "type": "string", "enum": [ "started", "completed", "unresolved" ] } } } }, "AssetResource": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "AssetPayloadContentType": { "type": "string" }, "AssetUploadResource": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AssetUploadPendingResource" }, { "$ref": "#/components/schemas/AssetUploadCompletedResource" }, { "$ref": "#/components/schemas/AssetUploadFailedResource" } ] }, "AssetUploadCreatedResourceWithUrl": { "type": "object", "required": [ "id", "status", "content_type", "upload_url" ], "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "pending" ] }, "content_type": { "$ref": "#/components/schemas/AssetPayloadContentType" }, "upload_url": { "type": "string" } } }, "AssetUploadCreatedResource": { "type": "object", "required": [ "id", "status", "content_type" ], "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "completed" ] }, "content_type": { "$ref": "#/components/schemas/AssetPayloadContentType" } } }, "AssetUploadPendingResource": { "type": "object", "required": [ "id", "status", "content_type" ], "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "pending" ] }, "content_type": { "$ref": "#/components/schemas/AssetPayloadContentType" } } }, "AssetUploadCompletedResource": { "type": "object", "required": [ "id", "status", "content_type" ], "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "completed" ] }, "content_type": { "$ref": "#/components/schemas/AssetPayloadContentType" } } }, "AssetUploadFailedResource": { "type": "object", "required": [ "id", "status", "content_type", "reason" ], "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "failed" ] }, "content_type": { "$ref": "#/components/schemas/AssetPayloadContentType" }, "reason": { "type": "string" } } }, "EmptyAssetDetailsResource": { "type": "object", "required": [ "id", "name", "payload" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "payload": { "oneOf": [ { "$ref": "#/components/schemas/AssetPayloadEmptyResource" } ] } } }, "AssetDetailsResource": { "type": "object", "required": [ "id", "name", "payload" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "payload": { "oneOf": [ { "$ref": "#/components/schemas/AssetPayloadEmptyResource" }, { "$ref": "#/components/schemas/AssetPayloadUrlResource" } ] } } }, "AssetPayloadEmptyResource": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "empty" ] } } }, "AssetPayloadDataResource": { "type": "object", "required": [ "type", "content_type", "data" ], "properties": { "type": { "type": "string", "enum": [ "data" ] }, "content_type": { "$ref": "#/components/schemas/AssetPayloadContentType" }, "data": { "type": "string" } } }, "AssetPayloadUrlResource": { "type": "object", "required": [ "type", "content_type", "url" ], "properties": { "type": { "type": "string", "enum": [ "url" ] }, "content_type": { "$ref": "#/components/schemas/AssetPayloadContentType" }, "url": { "type": "string" } } }, "TaskPackageResource": { "type": "object", "required": [ "id", "name", "type", "tasks", "download", "configuration" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "zip", "github", "gitlab", "public_git" ] }, "tasks": { "type": "array", "description": "Tasks contained in the task package: empty array if the task package has not been uploaded yet.", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } }, "download": { "type": "object", "nullable": true, "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL to download the task package. Null if the task package has not been uploaded yet." } } }, "configuration": { "nullable": true, "type": "object", "description": "The configuration of the task package. Null if task package is of type `zip`", "required": [ "repository", "mode", "branch", "automatic_deployment", "reference" ], "properties": { "repository": { "type": "string", "description": "The URL of the repository that contains the code for the task package." }, "mode": { "type": "string", "nullable": true, "enum": [ "attached", "detached" ], "description": "Setting the mode to attached will pin the task package to the latest commit of the specified branch. Setting the mode to detached will pin the task package to the specified reference. Null if task package is of type `public_git`." }, "branch": { "nullable": true, "type": "string", "description": "The branch to which the task package will point when in attached mode. Null if mode is `detached` or if type is `public_git`." }, "automatic_deployment": { "nullable": true, "type": "boolean", "description": "If true, changes on the repository will be automatically applied to the task package. If false, the deployment will be done manually by clicking `Pull latest` in Control Room. Null if mode is `detached` or if type is `public_git`." }, "reference": { "nullable": true, "type": "string", "description": "The reference of the commit to which the task package will point when in detached mode. Null if mode is `attached` or if type is `public_git`." } } } } }, "AssistantResource": { "type": "object", "required": [ "id", "name", "task", "created_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "task": { "type": "object", "required": [ "package_id", "name" ], "properties": { "package_id": { "type": "string" }, "name": { "type": "string" } } }, "created_at": { "type": "string", "format": "date-time" } } }, "AssistantRunResource": { "type": "object", "required": [ "id", "state", "error", "started_at", "ended_at", "duration", "assistant" ], "properties": { "id": { "type": "string" }, "state": { "type": "string", "enum": [ "in_progress", "completed", "failed" ] }, "error": { "type": "object", "nullable": true, "required": [ "code" ], "properties": { "code": { "type": "string" } } }, "started_at": { "type": "string", "format": "date-time" }, "ended_at": { "type": "string", "nullable": true, "format": "date-time" }, "duration": { "type": "number", "nullable": true }, "assistant": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "StepRunResource": { "type": "object", "required": [ "id", "state", "state_updated_at", "error", "started_at", "ended_at", "duration", "step" ], "properties": { "id": { "type": "string" }, "state": { "type": "string", "enum": [ "new", "awaiting_worker", "in_progress", "completed", "failed" ] }, "state_updated_at": { "type": "string", "format": "date-time" }, "error": { "type": "object", "description": "An object containing the error code, if the run failed.", "nullable": true, "required": [ "code" ], "properties": { "code": { "type": "string" } } }, "started_at": { "type": "string", "format": "date-time", "nullable": true }, "ended_at": { "type": "string", "format": "date-time", "nullable": true }, "duration": { "type": "number", "nullable": true }, "step": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "WorkerToGroupLinkListing": { "type": "object", "required": [ "worker", "worker_groups" ], "properties": { "worker": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "worker_groups": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } } }, "AgentPackageResource": { "type": "object", "required": [ "organization", "name", "releases" ], "properties": { "organization": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "name": { "type": "string" }, "releases": { "type": "array", "items": { "type": "object", "required": [ "id", "version", "url", "updated_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "version": { "type": "string", "nullable": true }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "AgentPackageReleaseResource": { "type": "object", "required": [ "id", "status", "error", "upload", "package" ], "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "pending_upload", "processing", "failed", "published" ] }, "upload": { "type": "object", "nullable": true, "required": [ "url", "type" ], "properties": { "type": { "type": "string", "enum": [ "aws_s3_presigned_url" ] }, "url": { "type": "string" } } }, "error": { "type": "object", "nullable": true, "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "invalid_content", "version_already_exists" ] }, "message": { "type": "string" } } }, "package": { "type": "object", "nullable": true, "required": [ "type", "details" ], "properties": { "type": { "type": "string", "enum": [ "agent" ] }, "details": { "type": "object", "required": [ "id", "name", "version", "url", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" }, "url": { "type": "string" } } } } } } }, "validationErrorResponse": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "genericErrorResponse": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } }, "anyValidJson": { "oneOf": [ { "type": "object" }, { "type": "array", "items": {} }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "anyValidJsonOptional": { "oneOf": [ { "type": "object" }, { "type": "array", "items": {} }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "paginationDetails": { "type": "object", "required": [ "next", "has_more" ], "properties": { "next": { "type": "string", "description": "The full URL to access the next set of results. Null if there are no next set of results.", "nullable": true, "format": "url" }, "has_more": { "type": "boolean", "description": "Whether or not there are more elements available after this set. If false, this set comprises the end of the list." } } } } }, "servers": [ { "url": "https://cloud.robocorp.com/api/v1/", "description": "Control Room API server endpoint" } ], "paths": { "/workspaces/{workspace_id}": { "get": { "tags": [ "workspace" ], "summary": "Get workspace", "description": "Returns the workspace.", "operationId": "getWorkspace", "security": [ { "API Key with permissions": [] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Workspace", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceResource" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/workers": { "get": { "tags": [ "worker" ], "summary": "List workers", "description": "Returns a list of all workers linked to the requested workspace.", "operationId": "listWorkers", "security": [ { "API Key with permissions": [ "Workers.read_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Workers", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "next", "has_more", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkerResource" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/workers/link-tokens": { "post": { "tags": [ "worker" ], "summary": "Create worker link token", "description": "Generates and returns a link token used to link a new worker to the requested workspace.", "operationId": "createLinkToken", "security": [ { "API Key with permissions": [ "Workers.write_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker should reside.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "expires_at" ], "properties": { "expires_at": { "type": "string", "format": "date-time" } } } } } }, "responses": { "200": { "description": "Worker Link Token", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkTokenResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/workers/{worker_id}": { "get": { "tags": [ "worker" ], "summary": "Get worker", "description": "Returns a worker linked to the requested workspace.", "operationId": "getWorker", "security": [ { "API Key with permissions": [ "Workers.read_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_id", "description": "The id of the worker to retrieve.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Worker", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "post": { "tags": [ "worker" ], "summary": "Update worker", "description": "Updates the requested worker by setting only the values defined in the request body.", "operationId": "updateWorker", "security": [ { "API Key with permissions": [ "Workers.write_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_id", "description": "The id of the worker to update.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The worker details to update.", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } } } }, "responses": { "200": { "description": "Worker", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "delete": { "tags": [ "worker" ], "summary": "Delete worker", "description": "Deletes the requested worker. This action is irreversible!", "operationId": "deleteWorker", "security": [ { "API Key with permissions": [ "Workers.write_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_id", "description": "The id of the worker to delete.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted Worker", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "deleted" ], "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean", "enum": [ true ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/worker-groups": { "get": { "tags": [ "worker-group" ], "summary": "List worker groups", "description": "Returns a list of all worker groups linked to the requested workspace.", "operationId": "listWorkerGroups", "security": [ { "API Key with permissions": [ "Workers.read_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace to list worker groups for", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Worker Groups", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "next", "has_more", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkerGroupResource" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "post": { "tags": [ "worker-group" ], "summary": "Create worker group", "description": "Creates a new worker group linked to the requested workspace.", "operationId": "createWorkerGroup", "security": [ { "API Key with permissions": [ "Workers.write_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace under which the worker group should be created.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The name of the worker group to create", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } } } }, "responses": { "200": { "description": "Worker Group", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerGroupResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/worker-groups/{worker_group_id}": { "get": { "tags": [ "worker-group" ], "summary": "Get worker group", "description": "Returns a worker group linked to the requested workspace.", "operationId": "getWorkerGroup", "security": [ { "API Key with permissions": [ "Workers.read_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker group resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_group_id", "description": "The id of the worker group to retrieve.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Worker Group", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerGroupResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "post": { "tags": [ "worker-group" ], "summary": "Update worker group", "description": "Updates the requested worker group by setting only the values defined in the request body.", "operationId": "updateWorkerGroup", "security": [ { "API Key with permissions": [ "Workers.write_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker group resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_group_id", "description": "The id of the worker group to update.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The worker group details to update", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } } } }, "responses": { "200": { "description": "Worker Group", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerGroupResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "delete": { "tags": [ "worker-group" ], "summary": "Delete worker group", "description": "Deletes the requested worker group. This action is irreversible!", "operationId": "deleteWorkerGroup", "security": [ { "API Key with permissions": [ "Workers.write_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker group resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_group_id", "description": "The id of the worker group to delete.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted Worker Group", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "deleted" ], "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean", "enum": [ true ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/worker-groups/{worker_group_id}/workers": { "post": { "tags": [ "worker-group" ], "summary": "Add worker to worker group", "description": "Adds an existing worker to the requested worker group.", "operationId": "addWorkerToGroup", "security": [ { "API Key with permissions": [ "Workers.write_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker group resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_group_id", "description": "The id of the worker group to add the worker to", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The id of the worker to add to the worker group\n", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "worker" ], "properties": { "worker": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Worker Group Link Listing", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerToGroupLinkListing" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/worker-groups/{worker_group_id}/workers/{worker_id}": { "delete": { "tags": [ "worker-group" ], "summary": "Remove worker from worker group", "description": "Removes an existing worker from the requested worker group.", "operationId": "removeWorkerFromGroup", "security": [ { "API Key with permissions": [ "Workers.write_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker group resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_group_id", "description": "The id of the worker group to remove the worker from", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_id", "description": "The id of the worker to remove from the worker group", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Worker Group Link Listing", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerToGroupLinkListing" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/worker-groups/{worker_group_id}/link-tokens": { "get": { "tags": [ "worker-group" ], "summary": "List worker group link tokens", "description": "Returns a list of all link tokens for the requested worker group.\n**Note:** For security reasons, the link token value can be retrieved in Control Room only.\n", "operationId": "listWorkerGroupLinkTokens", "security": [ { "API Key with permissions": [ "Workers.read_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker group resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_group_id", "description": "The id of the worker group to which the link tokens belong.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Worker Group Link Tokens", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "next", "has_more", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkerGroupLinkTokenResource" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "post": { "tags": [ "worker-group" ], "summary": "Create worker group link token", "description": "Generates and returns a link token used to link a worker to the requested worker group.\n**Note:** For security reasons, the link token value can be retrieved in Control Room only.\n", "operationId": "createWorkerGroupLinkToken", "security": [ { "API Key with permissions": [ "Workers.write_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker group resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_group_id", "description": "The id of the worker group to which the link token belongs.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The name of the worker group link token to create\n", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "expires_at" ], "properties": { "name": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time", "nullable": true } } } } } }, "responses": { "200": { "description": "Worker Group Link Token", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerGroupLinkTokenResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/worker-groups/{worker_group_id}/link-tokens/{link_token_id}": { "get": { "tags": [ "worker-group" ], "summary": "Get worker group link token", "description": "Returns a link token for the requested work group.\n**Note**: For security reasons, the Link Token value can be retrieved in Control Room only.\n", "operationId": "getWorkerGroupLinkToken", "security": [ { "API Key with permissions": [ "Workers.read_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker group resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_group_id", "description": "The id of the worker group to which the link token belongs.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "link_token_id", "description": "The id of the worker group link token to retrieve.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Worker Group Link Token", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerGroupLinkTokenResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "post": { "tags": [ "worker-group" ], "summary": "Update worker group link token", "description": "Updates a link token by setting only the values defined in the request body.", "operationId": "updateWorkerGroupLinkToken", "security": [ { "API Key with permissions": [ "Workers.write_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker group resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_group_id", "description": "The id of the worker group to which the link token belongs.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "link_token_id", "description": "The id of the worker group link token to update.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The name of the worker group link token to update", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "expires_at" ], "properties": { "name": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time", "nullable": true } } } } } }, "responses": { "200": { "description": "Worker Group Link Token", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerGroupLinkTokenResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "delete": { "tags": [ "worker-group" ], "summary": "Delete worker group link token", "description": "Deletes the requested link token. This action is irreversible!", "operationId": "deleteWorkerGroupLinkToken", "security": [ { "API Key with permissions": [ "Workers.write_workers" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker group resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "worker_group_id", "description": "The id of the worker group to which the link token belongs.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "link_token_id", "description": "The id of the worker group link token to delete.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted Worker Group Link Token", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "deleted" ], "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean", "enum": [ true ] } } } } } }, "400": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/process-runs": { "get": { "tags": [ "process-run" ], "summary": "List process runs", "description": "Returns a paginated list of process runs. If a process id is specified in the query parameters, the response will only contain process runs from that process. If not, the response will contain the process runs of the workspace in the path.", "operationId": "listProcessRuns", "security": [ { "API Key with permissions": [ "Processes.read_runs" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "process_id", "description": "Process ID, if specified, the response will only contain the process runs from this process", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "state", "description": "State of process runs", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "new", "in_progress", "completed", "unresolved", "stopping" ] } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Process Runs", "content": { "application/json": { "schema": { "type": "object", "required": [ "next", "has_more", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessRunResource" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/processes/{process_id}/process-runs-integrations": { "post": { "tags": [ "process-run" ], "summary": "Start process run (for integrations)", "description": "Starts a process run for the requested process.\nThis endpoint is useful when you don't have control over the **headers** and / or **request body** of the caller and need a plain URL. This includes e.g. certain integration cases.\nThe **full request body** will be provided as the input work item for the process run.\nThe **API Key** must be provided as the value of the `token` query-string parameter.\nThis endpoint supports **webhook handshakes** for added security. Currently we support the protocol employed by [Asana](https://asana.com/).\nIf you are using Asana, use the `with_handshake=asana` query string parameter when constructing the URL to enable Asana webhook handshakes.\n", "operationId": "startProcessRunQsAuth", "security": [ { "API Key with permissions": [ "Processes.trigger_processes" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "process_id", "description": "Process ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "token", "description": "Authorization token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "with_handshake", "description": "Handshake type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asana" ] } } ], "requestBody": { "description": "Any valid JSON payload.\nThe full request body is passed as a work item to the process run input.\n", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/anyValidJson" } } } }, "responses": { "200": { "description": "Started Process Run", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "started", "id" ], "properties": { "started": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/processes/{process_id}/process-runs": { "post": { "tags": [ "process-run" ], "summary": "Start process run", "description": "Starts a process run for the requested process.\nYou may choose to start a process run without work items, with specified work items, or with the work items that are waiting in the input queue of the specified process.\n", "operationId": "startProcessRun", "security": [ { "API Key with permissions": [ "Processes.trigger_processes" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the process resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "process_id", "description": "The id of the process to start.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Omitting the request body will start a process run with either the default work item, if configured, or an empty work item.\n", "required": false, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "nullable": true, "properties": { "callback": { "$ref": "#/components/schemas/ProcessRunCallback" } } }, { "type": "object", "required": [ "type", "work_item_ids" ], "properties": { "type": { "type": "string", "enum": [ "with_work_item_ids" ] }, "work_item_ids": { "description": "Work item ids to start the run with.", "type": "array", "items": { "type": "string" } }, "callback": { "$ref": "#/components/schemas/ProcessRunCallback" } } }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "with_inputs" ] }, "callback": { "$ref": "#/components/schemas/ProcessRunCallback" } } }, { "type": "object", "required": [ "type", "payloads" ], "properties": { "type": { "type": "string", "enum": [ "with_payloads" ] }, "payloads": { "type": "array", "items": { "$ref": "#/components/schemas/WorkItemPayload" } }, "callback": { "$ref": "#/components/schemas/ProcessRunCallback" } } } ] } } } }, "responses": { "200": { "description": "Started Process Run", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "description": "This signals that a new process run was not started. This happens when a process run start with Input Work Items is requested, but no Input Work Items are available.\n", "type": "object", "required": [ "started" ], "properties": { "started": { "type": "boolean", "enum": [ false ] } } }, { "type": "object", "required": [ "started", "id" ], "properties": { "started": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string" } } } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/process-runs/{process_run_id}": { "get": { "tags": [ "process-run" ], "summary": "Get process run", "description": "Returns a process run", "operationId": "getProcessRun", "security": [ { "API Key with permissions": [ "Processes.read_processes" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "process_run_id", "description": "ID of the process run", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Process Run", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessRunResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "delete": { "tags": [ "process-run" ], "summary": "Delete process run", "description": "Deletes a process run. This action is irreversible!", "operationId": "deleteProcessRun", "security": [ { "API Key with permissions": [ "Processes.trigger_processes" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the robot resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "process_run_id", "description": "The id of the process run to delete.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted Process Run", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "deleted" ], "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean", "enum": [ true ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/process-runs/{process_run_id}/stop": { "post": { "tags": [ "process-run" ], "summary": "Stop process run", "description": "Stops the process run.", "operationId": "stopProcessRun", "security": [ { "API Key with permissions": [ "Processes.trigger_processes" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the process run resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "process_run_id", "description": "The id of the process run to stop.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Set whether or not to set the remaining work items as done or terminating the ongoing activity runs, as well as the reason for stopping the process run.", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "set_remaining_work_items_as_done", "terminate_ongoing_activity_runs" ], "properties": { "set_remaining_work_items_as_done": { "type": "boolean" }, "terminate_ongoing_activity_runs": { "type": "boolean" }, "reason": { "type": "string" } } } } } }, "responses": { "200": { "description": "Stopped Process Run", "content": { "application/json": { "schema": { "type": "object", "required": [ "accepted" ], "properties": { "accepted": { "type": "boolean" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/processes": { "get": { "tags": [ "process" ], "summary": "List processes", "description": "Returns a list of all processes linked to the requested workspace.", "operationId": "listProcesses", "security": [ { "API Key with permissions": [ "Processes.read_processes" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Processes", "content": { "application/json": { "schema": { "type": "object", "required": [ "next", "has_more", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "created_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "post": { "tags": [ "process" ], "summary": "Create process", "description": "Creates a new process.", "operationId": "createProcess", "security": [ { "API Key with permissions": [ "Processes.write_processes" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the process resides.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Process to create", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "steps" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "default_input": { "type": "object", "example": { "any": "string" }, "additionalProperties": { "type": "string" } }, "notifications": { "description": "Up to 10 notification items", "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EmailNotificationConfig" }, { "$ref": "#/components/schemas/WebhookNotificationConfig" }, { "$ref": "#/components/schemas/SlackNotificationConfig" } ] } }, "steps": { "description": "Up to 10 steps", "type": "array", "items": { "type": "object", "required": [ "name", "task_package", "worker" ], "properties": { "name": { "type": "string" }, "task_package": { "type": "object", "required": [ "id", "task" ], "properties": { "id": { "type": "string" }, "task": { "type": "object", "required": [ "name" ], "properties": { "name": { "description": "Name of the specific task in the task package that will be execute by the worker in this step.", "type": "string" } } } } }, "worker": { "type": "object", "description": "The computing resource, Self-Hosted or in Cloud, that executes the configured Task.", "oneOf": [ { "$ref": "#/components/schemas/CloudWorker" }, { "$ref": "#/components/schemas/NonCloudWorker" } ] }, "environment_variables": { "type": "object", "example": { "any": "string" }, "additionalProperties": { "type": "string" } }, "maximum_parallel_execution": { "type": "number" }, "execution_timeout": { "description": "Max duration for the execution (in seconds)", "type": "number" }, "conditional_start": { "type": "object", "required": [ "all_work_items_in_previous_steps_processed" ], "properties": { "all_work_items_in_previous_steps_processed": { "description": "If true, the step run will only start if all the work items from previous steps are either done or failed.", "type": "boolean" } } }, "desktop_connection": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "description": "If true, this step will use Remote Desktop Protocol (RDP) with predefined credentials to run the step. Supported for Windows worker only.", "type": "boolean" }, "login_timeout": { "description": "If specified, the connection will be closed if the user has not logged in by that time.", "type": "number" }, "do_not_sign_out_after_run": { "description": "Leaves user session and applications open after a step run.", "type": "boolean" }, "video_streaming_enabled": { "description": "Capture a screen recording of this step", "type": "boolean" } } } } } }, "schedules": { "description": "The type of schedule for this process: CRON, interval or weekday. Schedule types cannot be mixed. Only one schedule for CRON and interval allowed.", "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/CronScheduleConfig" }, { "$ref": "#/components/schemas/IntervalScheduleConfig" }, { "$ref": "#/components/schemas/WeekdayScheduleConfig" } ] } }, "triggers": { "description": "Set up an email that will trigger the process. The created process will have an email address that will trigger the process on every received email. Only one trigger for email allowed currently.", "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EmailTriggerConfig" } ] } } } } } } }, "responses": { "200": { "description": "Created Process", "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "409": { "description": "Conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/work-items/batch": { "post": { "tags": [ "work-item" ], "summary": "Retry, delete or mark work items as done", "description": "Run a batch operation on one or more work items.\nYou can retry, delete or mark failed work items as done.\n", "operationId": "runWorkItemBatchOperation", "security": [ { "API Key with permissions": [ "Processes.write_work_items" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Work item batch operation", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "batch_operation", "work_item_ids" ], "properties": { "batch_operation": { "type": "string", "enum": [ "retry", "delete", "mark_as_done" ] }, "work_item_ids": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Work item batch operation result", "content": { "application/json": { "schema": { "type": "object", "required": [ "accepted" ], "properties": { "accepted": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "/workspaces/{workspace_id}/work-items": { "get": { "tags": [ "work-item" ], "summary": "List work items", "description": "Returns a paginated list of work items. You can specify filtering work item by state, process_id and process_run_id using the query parameters.\n", "operationId": "listWorkItems", "security": [ { "API Key with permissions": [ "Processes.read_work_items" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "process_id", "description": "Process ID", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "process_run_id", "description": "Process Run ID", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "state", "description": "Work item state filter", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/WorkItemState" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Work Items", "content": { "application/json": { "schema": { "type": "object", "required": [ "next", "has_more", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkItemWithoutDataResource" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "post": { "tags": [ "work-item" ], "summary": "Create work item", "description": "Create a work item for the requested process.", "operationId": "createWorkItem", "security": [ { "API Key with permissions": [ "Processes.write_work_items" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Process work item payload", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "process", "payload" ], "properties": { "process": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "payload": { "$ref": "#/components/schemas/WorkItemPayload" } } } } } }, "responses": { "200": { "description": "Work Item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkItemResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "409": { "description": "Conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/work-items/{work_item_id}": { "get": { "tags": [ "work-item" ], "summary": "Get work item", "description": "Returns a work item for the requested process. You can specify whether you want to also retrieve the work item's data (payload and/or files) by supplying the `include_data` query parameter.\n", "operationId": "getWorkItem", "security": [ { "API Key with permissions": [ "Processes.read_work_items" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "work_item_id", "description": "Work Item ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Work Item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkItemResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/work-items/{work_item_id}/files": { "post": { "tags": [ "work-item" ], "summary": "Create work item file", "description": "Request to upload a work item file.", "operationId": "createWorkItemFile", "security": [ { "API Key with permissions": [ "Processes.write_work_items" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "work_item_id", "description": "Work Item ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The name and size of work item file to create", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "file_name", "file_size" ], "properties": { "file_name": { "type": "string" }, "file_size": { "type": "number" } } } } } }, "responses": { "200": { "description": "Work Item File Upload Details", "content": { "application/json": { "schema": { "type": "object", "required": [ "upload" ], "properties": { "upload": { "type": "object", "required": [ "url", "form_data" ], "properties": { "url": { "type": "string" }, "form_data": { "type": "object", "description": "The form data fields you must include when uploading the file" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/work-items/{work_item_id}/payload": { "post": { "tags": [ "work-item" ], "summary": "Update work item payload", "description": "Update the payload for the requested work item.", "operationId": "updateWorkItemPayload", "security": [ { "API Key with permissions": [ "Processes.write_work_items" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "work_item_id", "description": "Work Item ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated payload of work item", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "payload" ], "properties": { "payload": { "$ref": "#/components/schemas/anyValidJson" } } } } } }, "responses": { "200": { "description": "Work Item Payload", "content": { "application/json": { "schema": { "type": "object", "required": [ "payload" ], "properties": { "payload": { "$ref": "#/components/schemas/anyValidJson" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/outputs": { "get": { "tags": [ "process-run" ], "summary": "List process run outputs", "description": "Returns a list of process run outputs.", "operationId": "listProcessRunOutputs", "security": [ { "API Key with permissions": [ "Processes.read_work_items" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "process_run_id", "description": "Process Run ID", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Process Run Outputs", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "has_more", "next", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessRunOutputResource" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/task-packages": { "get": { "tags": [ "task-package" ], "summary": "List task packages", "description": "List task packages in the requested workspace.", "operationId": "listTaskPackages", "security": [ { "API Key with permissions": [ "Tasks.read_task_packages" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace in which to create the task package", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List task packages", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "has_more", "next" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "zip", "github", "gitlab", "public_git", "command" ] }, "created_at": { "type": "string", "format": "date-time" } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "post": { "tags": [ "task-package" ], "summary": "Create new task package", "description": "Creates a new task package with the given name in the requested workspace.", "operationId": "createTaskPackage", "security": [ { "API Key with permissions": [ "Tasks.write_task_packages" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace in which to create the task package", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The name of the task package to create", "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateZipTaskPackage" }, { "$ref": "#/components/schemas/CreatePublicGitTaskPackage" }, { "$ref": "#/components/schemas/CreateGitIntegrationTaskPackage" } ] } } } }, "responses": { "200": { "description": "Task Package", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskPackageResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "409": { "description": "Conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/task-packages/{task_package_id}": { "get": { "tags": [ "task-package" ], "summary": "Get task package", "description": "Returns a task package (zip type only), including the URL to download it as well as the URL and form data to upload a new version", "operationId": "getTaskPackage", "security": [ { "API Key with permissions": [ "Tasks.read_task_packages" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the task package resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "task_package_id", "description": "The id of the task package to retrieve.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Task Package", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskPackageResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "post": { "tags": [ "task-package" ], "summary": "Update task package", "description": "Update task package configuration. Note that changing the type of an existing task package is not supported via the API.", "operationId": "updateTaskPackage", "security": [ { "API Key with permissions": [ "Tasks.write_task_packages" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the task package resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "task_package_id", "description": "The id of the task package to retrieve.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "configuration" ], "properties": { "type": { "type": "string", "enum": [ "github", "gitlab" ], "description": "Task package application type." }, "configuration": { "oneOf": [ { "type": "object", "required": [ "mode", "branch", "automatic_deployment" ], "properties": { "mode": { "type": "string", "enum": [ "attached" ], "description": "Task package can be updated based on latest changes." }, "branch": { "type": "string", "description": "An existing git branch on the repository." }, "automatic_deployment": { "type": "boolean", "description": "If enabled, any changes are automatically pulled. If disabled, the task package will point to the head commit at the time of the update." } } }, { "type": "object", "required": [ "mode", "reference" ], "properties": { "mode": { "type": "string", "enum": [ "detached" ], "description": "Task package will point only to specified reference." }, "reference": { "type": "string", "description": "An existing commit hash, tag or branch on the repository." } } } ] } } } } } }, "responses": { "200": { "description": "Updated task package configuration", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "github", "gitlab" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "delete": { "tags": [ "task-package" ], "summary": "Delete task package", "description": "Deletes a specific task package. This action is irreversible!", "operationId": "deleteTaskPackage", "security": [ { "API Key with permissions": [ "Tasks.write_task_packages" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the task package resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "task_package_id", "description": "The id of the task package to delete.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted Task Package", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "deleted" ], "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean", "enum": [ true ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/assets": { "get": { "tags": [ "asset" ], "summary": "List assets", "description": "Returns a list of all assets linked to the requested workspace.", "operationId": "listAssets", "security": [ { "API Key with permissions": [ "Assets.read_asset_storage_assets" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Assets", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "has_more", "next" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "post": { "tags": [ "asset" ], "summary": "Create new asset", "description": "Creating an asset is a multi-step process, see “Create an asset upload” to specify the data.", "operationId": "createAsset", "security": [ { "API Key with permissions": [ "Assets.write_asset_storage_assets" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker should reside.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } } } }, "responses": { "200": { "description": "Asset", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyAssetDetailsResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/assets/{asset_id}": { "get": { "tags": [ "asset" ], "summary": "Get asset", "description": "Returns an asset for the requested workspace. The asset is returned including its payload.", "operationId": "getAsset", "security": [ { "API Key with permissions": [ "Assets.read_asset_storage_assets" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "asset_id", "description": "Asset ID or Asset Name prefixed with `name:` e.g. `name:my-asset-name`", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Asset", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDetailsResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "delete": { "tags": [ "asset" ], "summary": "Delete asset", "description": "Deletes the requested asset. This action is irreversible!", "operationId": "deleteAsset", "security": [ { "API Key with permissions": [ "Assets.write_asset_storage_assets" ] } ], "parameters": [ { "name": "workspace_id", "description": "The id of the workspace on which the worker resides.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "asset_id", "description": "Asset ID or Asset Name prefixed with `name:` e.g. `name:my-asset-name`", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted Asset", "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "deleted" ], "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean", "enum": [ true ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/assets/{asset_id}/uploads": { "post": { "tags": [ "asset" ], "summary": "Create asset upload", "description": "Create an upload for the requested asset payload. For payloads with less than 5MB you can upload the contents directly on the upload creation by specifying the data field. For larger uploads you can create the upload and use the returned upload URL for uploading the contents.", "operationId": "createAssetUpload", "security": [ { "API Key with permissions": [ "Assets.write_asset_storage_assets" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "asset_id", "description": "Asset ID or Asset Name prefixed with `name:` e.g. `name:my-asset-name`", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "content_type" ], "properties": { "content_type": { "type": "string" }, "data": { "type": "string" } } } } } }, "responses": { "200": { "description": "Asset Upload", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AssetUploadCreatedResource" }, { "$ref": "#/components/schemas/AssetUploadCreatedResourceWithUrl" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/assets/{asset_id}/uploads/{upload_id}": { "get": { "tags": [ "asset" ], "summary": "Get asset upload", "description": "Get the upload of an asset.", "operationId": "getAssetUpload", "security": [ { "API Key with permissions": [ "Assets.write_asset_storage_assets" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "asset_id", "description": "Asset ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "upload_id", "description": "Payload Upload ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Asset Upload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetUploadResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/webhooks": { "get": { "tags": [ "webhooks" ], "summary": "List webhooks", "description": "Retrieves a list of all webhooks for the requested workspace.", "operationId": "listWebhooks", "security": [ { "API Key with permissions": [ "Webhooks.read_webhooks" ] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The ID of the workspace" }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Webhooks", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "has_more", "next" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "process", "enabled_events", "endpoint" ], "properties": { "id": { "type": "string" }, "process": { "nullable": true, "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "enabled_events": { "$ref": "#/components/schemas/WebhookEnabledEvents" }, "endpoint": { "type": "string", "format": "url" } } } }, "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "post": { "tags": [ "webhooks" ], "summary": "Create process webhook", "description": "Creates a process webhook for the requested workspace.", "operationId": "createWebhook", "security": [ { "API Key with permissions": [ "Webhooks.write_webhooks" ] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The ID of the workspace" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessWebhookPayload" } } } }, "responses": { "200": { "description": "Webhook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/webhooks/{webhook_id}": { "get": { "tags": [ "webhooks" ], "summary": "Get webhook", "description": "Returns a webhook for the requested workspace.", "operationId": "getWebhook", "security": [ { "API Key with permissions": [ "Webhooks.read_webhooks" ] } ], "parameters": [ { "name": "workspace_id", "required": true, "in": "path", "schema": { "type": "string" }, "description": "The ID of the workspace" }, { "name": "webhook_id", "required": true, "in": "path", "schema": { "type": "string" }, "description": "The ID of the webhook" } ], "responses": { "200": { "description": "Webhook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "delete": { "tags": [ "webhooks" ], "summary": "Delete webhook", "description": "Deletes the requested webhook. This action is irreversible!", "operationId": "deleteWebhook", "security": [ { "API Key with permissions": [ "Webhooks.write_webhooks" ] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The ID of the workspace" }, { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The ID of the webhook" } ], "responses": { "200": { "description": "Deleted Webhook", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "deleted" ], "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean", "enum": [ true ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/step-runs": { "get": { "tags": [ "step-run" ], "summary": "List step runs", "description": "Returns a paginated list of step runs.", "operationId": "listStepRuns", "security": [ { "API Key with permissions": [ "Processes.read_processes" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "process_run_id", "description": "Process Run ID", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Step Runs", "content": { "application/json": { "schema": { "type": "object", "required": [ "next", "has_more", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StepRunResource" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/step-runs/{step_run_id}": { "get": { "tags": [ "step-run" ], "summary": "Get step run", "description": "Returns a specific step run from a process run.", "operationId": "getStepRun", "security": [ { "API Key with permissions": [ "Processes.read_runs" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "step_run_id", "description": "ID of the step run", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Step Run", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepRunResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/step-runs/{step_run_id}/artifacts": { "get": { "tags": [ "step-run" ], "summary": "List step run artifacts", "description": "Returns the list of all artifacts for a step run.", "operationId": "listStepRunArtifacts", "security": [ { "API Key with permissions": [ "Processes.read_run_outputs" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "step_run_id", "description": "Step Run ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Artifacts", "content": { "application/json": { "schema": { "type": "object", "required": [ "next", "has_more", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "size" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "size": { "type": "number" } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/step-runs/{step_run_id}/artifacts/{artifact_id}": { "get": { "tags": [ "step-run" ], "summary": "Get step run artifact", "description": "Returns a step run artifact.", "operationId": "getStepRunArtifact", "security": [ { "API Key with permissions": [ "Processes.read_run_outputs" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "step_run_id", "description": "ID of the step run", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "artifact_id", "description": "ID of the artifact to retrieve", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Artifact", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "size", "url" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "size": { "type": "number" }, "url": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/step-runs/{step_run_id}/console-messages": { "get": { "tags": [ "step-run" ], "summary": "List step run console messages", "description": "Returns a paginated list of console messages for the step run.", "operationId": "listStepRunConsoleMessages", "security": [ { "API Key with permissions": [ "Processes.read_run_outputs" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "step_run_id", "description": "Step Run ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Step Run Console Messages", "content": { "application/json": { "schema": { "type": "object", "required": [ "next", "has_more", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "type": "object", "required": [ "timestamp", "message" ], "properties": { "timestamp": { "type": "string", "format": "date-time" }, "message": { "type": "string" } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/step-runs/{step_run_id}/events": { "get": { "tags": [ "step-run" ], "summary": "List step run events", "description": "Returns the events of a step run.", "operationId": "listStepRunEvents", "security": [ { "API Key with permissions": [ "Processes.read_run_outputs" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "step_run_id", "description": "ID of the step run", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Events", "content": { "application/json": { "schema": { "type": "object", "required": [ "next", "has_more", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "type": "object", "required": [ "timestamp", "event_type" ], "properties": { "timestamp": { "type": "string" }, "event_type": { "type": "string" } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/assistants": { "get": { "tags": [ "assistant" ], "summary": "List assistants", "description": "Returns a paginated list of assistants for the workspace.", "operationId": "listAssistants", "security": [ { "API Key with permissions": [ "Assistants.read_assistants" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Assistants", "content": { "application/json": { "schema": { "type": "object", "required": [ "next", "has_more", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssistantResource" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "post": { "tags": [ "assistant" ], "summary": "Create assistant", "description": "Creates a new assistant with the given name and for the specified task inside a task package.", "operationId": "createAssistant", "security": [ { "API Key with permissions": [ "Assistants.write_assistants" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "task" ], "properties": { "name": { "type": "string" }, "task": { "type": "object", "required": [ "name", "package_id" ], "properties": { "name": { "type": "string" }, "package_id": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Assistant", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/assistants/{assistant_id}": { "get": { "tags": [ "assistant" ], "summary": "Get assistant", "description": "Returns an assistant", "operationId": "getAssistant", "security": [ { "API Key with permissions": [ "Assistants.read_assistants" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assistant_id", "description": "Assistant ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Assistant", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "task", "created_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "task": { "type": "object", "required": [ "name", "package_id" ], "properties": { "name": { "type": "string" }, "package_id": { "type": "string" } } }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/assistant-runs/{assistant_run_id}": { "get": { "tags": [ "assistant" ], "summary": "Get assistant run", "description": "Returns an assistant run for the requested assistant.", "operationId": "getAssistantRun", "security": [ { "API Key with permissions": [ "Assistants.read_assistants" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assistant_run_id", "description": "Assistant Run ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Assistant Run", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssistantRunResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/assistant-runs": { "get": { "tags": [ "assistant" ], "summary": "List assistant runs", "description": "Returns a paginated list of assistant runs. If an assistant id is specified, the response will only contain assistant runs for that assistant, otherwise it will return the assistant runs for all assistants in the workspace.", "operationId": "listAssistantRuns", "security": [ { "API Key with permissions": [ "Assistants.read_assistants" ] } ], "parameters": [ { "name": "workspace_id", "description": "Workspace ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assistant_id", "description": "Assistant ID. If specified, the response will only contain assistant runs for that assistant.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "description": "Limit for paginated response", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "List of Assistant Runs", "content": { "application/json": { "schema": { "type": "object", "required": [ "next", "has_more", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssistantRunResource" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/processes/{process_id}": { "get": { "tags": [ "process" ], "summary": "Get process", "description": "Returns the process.", "operationId": "getProcess", "security": [ { "API Key with permissions": [ "Processes.read_processes" ] } ], "parameters": [ { "name": "workspace_id", "description": "ID of the workspace", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "process_id", "description": "ID of the process", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Process", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "description", "created_at", "steps" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "steps": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "worker" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "worker": { "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "self_hosted_worker", "cloud_worker", "worker_group", "on_demand_worker" ] }, "id": { "type": "string", "description": "ID of the worker type. Note that currently only self_hosted_worker and worker_group informations can be retrieved using the API, respectively worker and worker group API endpoints." } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/secrets": { "get": { "tags": [ "vault" ], "summary": "List secrets", "description": "Returns a list of all secrets linked to the requested workspace.", "operationId": "listSecrets", "security": [ { "API Key with permissions": [ "Vault.read_secrets" ] } ], "parameters": [ { "name": "workspace_id", "description": "ID of the workspace", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Secret", "content": { "application/json": { "schema": { "type": "object", "required": [ "next", "has_more", "data" ], "properties": { "next": { "$ref": "#/components/schemas/paginationDetails/properties/next" }, "has_more": { "$ref": "#/components/schemas/paginationDetails/properties/has_more" }, "data": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true } } } } } } } } } } }, "post": { "tags": [ "vault" ], "summary": "Create secret", "description": "Creates a new secret in the vault.", "operationId": "createSecret", "security": [ { "API Key with permissions": [ "Vault.write_secrets" ] } ], "parameters": [ { "name": "workspace_id", "description": "ID of the workspace", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "items", "description" ], "properties": { "name": { "type": "string", "description": "Name of the secret, must be a unique combination of letters, numbers and underscores, with no spaces." }, "items": { "type": "object", "example": { "any": "string" }, "additionalProperties": { "type": "string" } }, "description": { "type": "string", "nullable": true } } } } } }, "responses": { "200": { "description": "Secret", "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } }, "/workspaces/{workspace_id}/secrets/{secret_name}": { "post": { "tags": [ "vault" ], "summary": "Update secret", "description": "Updates a secret from the vault. Note that the secret items passed in the payload will replace all existing secret items.", "operationId": "updateSecret", "security": [ { "API Key with permissions": [ "Vault.write_secrets" ] } ], "parameters": [ { "name": "workspace_id", "description": "ID of the workspace", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "Name of the secret", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "description" ], "properties": { "items": { "type": "object" }, "description": { "type": "string", "nullable": true } } } } } }, "responses": { "200": { "description": "Secret", "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } }, "delete": { "tags": [ "vault" ], "summary": "Delete secret", "description": "Deletes a secret from the vault.", "operationId": "deleteSecret", "security": [ { "API Key with permissions": [ "Vault.write_secrets" ] } ], "parameters": [ { "name": "workspace_id", "description": "ID of the workspace", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "Name of the secret", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted Secret", "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "deleted" ], "properties": { "name": { "type": "string" }, "deleted": { "type": "boolean", "enum": [ true ] } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericErrorResponse" } } } } } } } } }