Tasks
Get agent task by ID
Changed onRetrieve a specific agent task by its unique identifier
get/v1/tasks/{id}
Request
- Base URLhttps://api.jasper.ai
- URLhttps://api.jasper.ai/v1/tasks/{id}
- Auth
- API key in header X-API-Key
- or OAuth 2Authorization code: https://api.jasper.ai/oauth2/authorizeToken URL: https://api.jasper.ai/oauth2/token scopes: user:read
Path parameters
idstring required
Example:agt_0190f3a1b2c34d5e6f7a8b9c0d1e2f3a
The external ID (agt_…) or internal UUID of the agent task
Query parameters
versionnumber
The agent task version to filter by. If not provided, the latest version will be used.
Response
Successfully retrieved agent task
Example response
{
"requestId": "07008c5a-f916-4bdc-bfda-e8f6c328f7c5",
"resource": "tasks",
"data": {
"id": "agt_0190f3a1b2c34d5e6f7a8b9c0d1e2f3a",
"name": "Grammar Checker",
"appUrl": "https://app.jasper.ai/studio/962e4d4c-ffdc-4c7a-83e3-8f4e715004cf",
"description": "Ensure your text is free from grammar errors to enhance clarity and professionalism",
"contextItems": [
{
"id": "5e9f3d7b-9ec6-44e7-b752-3977fef34c18",
"name": "Original text",
"type": "TEXTAREA",
"question": "What text do you want to check?",
"options": [
"grammar",
"writing"
]
}
],
"version": 1,
"scope": "PUBLIC",
"updatedAt": "2024-10-29T03:47:44.468Z",
"createdAt": "2024-10-02T03:51:26.020Z",
"categories": []
}
}Changes
- breaking
the
///response's property type changed fromstringtoobjectfor status - breaking
the
/response's property type changed fromstringtoobjectfor status - breaking
the
/response's property type changed fromstringtoobjectfor status - breaking
the
/response's property type changed fromstringtoobjectfor status - breaking
the
/response's property type changed fromstringtoobjectfor status - info
added the required property
/to the response with the status
- breaking