Get Task Details

Retrieve detailed information about a specific Task. Returns the complete Task configuration including: - Basic properties (name, description, enabled status) - All revisions with their prompts and configurations - Currently active revisions and their traffic weights - Associated tags and metadata

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

OR
AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

org_idstringRequiredformat: "uuid"
The unique identifier of the organization.
project_idstringRequiredformat: "uuid"
The unique identifier of the project.
task_idstringRequiredformat: "uuid"
The specific Task to reference.

Query parameters

revision_tag_idstring or nullOptionalformat: "uuid"

Filter task_revisions by tag ID.

include_testsboolean or nullOptionalDefaults to false
Include test revisions

Response

Task details retrieved successfully
namestringformat: "^[a-zA-Z0-9\- ]+$"
A name or reference for the Task.
enabledboolean

When true the Task is active and callable. false denotes the Task is not yet operational.

idstringformat: "uuid"
The unique identifier of the Task.
project_idstringformat: "uuid"
The Project that the Task belongs to.
createdstring
When the Task was created.
access_tokenstring or null
Task specific Bearer token that can be used to authenticated when executing this Task.
active_revisionslist of objects
The revision currently active for this Task.
descriptionstring or nullOptional
A longer description of the Task for internal reference.
publicbooleanOptionalDefaults to false

When true the Task is public and can be accessed by any User.

exposed_to_agentsbooleanOptionalDefaults to false

When true the Task is accessible to agents through the unauthenticated agent endpoint.

output_modalityenumOptional
Specifies the output modality of the task. Can be 'json', 'image', 'audio', 'pdf', 'text', or 'csv'. Defaults to 'json'.
task_run_visibilityenumOptionalDefaults to owner_only

Controls who can view all task runs. ‘owner_only’ - only task owners see all runs (default), ‘editors_and_owners’ - task editors and owners see all runs, ‘all_viewers’ - all users with view permission see all runs.

modifiedstring or nullOptional
When the Task was last updated.
deletedstring or nullOptional
Timestamp when the task was deleted, if applicable.
revisionslist of objectsOptionalDefaults to []

Each update to a Task results in a new Revision being created. Task Revisions are a powerful concept that can be used to assist with A/B testing, comparing responses from different LLM’s, etc.

cloned_from_task_revision_idstring or nullOptionalformat: "uuid"
The unique identifier of the task revision this task was cloned from, if applicable.
tagslist of objectsOptionalDefaults to []
shared_with_projectbooleanOptionalDefaults to false

When true the Task is shared with members of its Project.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error