Tasks
Create New Task
- Website
- Trust Center
- Introduction
- Tasks
- Calls
- Templates
- Targets
- Batches
- Recordings
- Transcripts
- Scripts
Get Started
API Reference
Tasks
Create New Task
POST
/
tasks
Authorization
string
*
Bearer
Authorization
Required
string
The Opkit API uses the HTTP Bearer Token scheme for authentication. You should provide your API key in the Authorization header like so: "Authorization: Bearer [api-key]".
object
target_id
string
*
target_id
Required
string
script_id
string
script_id
string
batch_id
string
batch_id
string
template_id
string
*
template_id
Required
string
context
array
*
context
Required
array
objectives
array
*
objectives
Required
array
curl --request POST \
--url https://api.opkit.co/v1/tasks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"script_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
"<any>"
]
}
]
}
]
}
]
}
]
}
]
}
],
"objectives": [
{
"name": "<string>",
"description": "<string>",
"type": "string",
"enum": [
"<string>"
]
}
]
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"script_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"summary": "<string>",
"customer_feedback": "<string>",
"reviewed": true,
"flagged": true,
"flagged_reason": "script_deviation",
"outcome": "success",
"created_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"context": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
"<any>"
]
}
]
}
]
}
]
}
]
}
]
}
],
"objectives": [
{
"name": "<string>",
"description": "<string>",
"type": "string",
"enum": [
"<string>"
]
}
],
"results": [
{
"name": "<string>",
"value": "<string>",
"type": "string",
"enum": [
"<string>"
]
}
],
"duration_seconds": 123
}
Authorizations
Authorization
string
headerrequiredThe Opkit API uses the HTTP Bearer Token scheme for authentication. You should provide your API key in the Authorization header like so: "Authorization: Bearer [api-key]".
Body
application/json
target_id
string
requiredscript_id
string
batch_id
string
template_id
string
requiredcontext
object[]
requiredcontext.name
string
requiredcontext.description
string
requiredcontext.items
object[]
requiredcontext.items.name
string
requiredcontext.items.description
string
requiredcontext.items.items
object[]
requiredcontext.items.items.name
string
requiredcontext.items.items.description
string
requiredcontext.items.items.items
object[]
requiredcontext.items.items.items.name
string
requiredcontext.items.items.items.description
string
requiredcontext.items.items.items.items
object[]
requiredcontext.items.items.items.items.name
string
requiredcontext.items.items.items.items.description
string
requiredcontext.items.items.items.items.items
object[]
requiredcontext.items.items.items.items.items.name
string
requiredcontext.items.items.items.items.items.description
string
requiredcontext.items.items.items.items.items.items
any[]
requiredobjectives
object[]
requiredobjectives.name
string
requiredobjectives.description
string
requiredobjectives.type
enum<string>
requiredAvailable options:
string
, number
, integer
, currency
, date
, time
, enum
, boolean
, js-date-time
objectives.enum
string[]
Response
200 - application/json
id
string
requiredscript_id
string
summary
string
customer_feedback
string
reviewed
boolean
requiredflagged
boolean
requiredflagged_reason
enum<string> | null
Available options:
script_deviation
, inaccurate_results
, missing_results
, other
outcome
enum<string>
Available options:
success
, failure
created_at
string
requiredfinished_at
string
target_id
string
requiredbatch_id
string
requiredtemplate_id
string
requiredstatus
enum<string>
requiredAvailable options:
pending
, in_progress
, complete
, canceled
, paused
context
object[]
requiredcontext.name
string
requiredcontext.description
string
requiredcontext.items
object[]
requiredcontext.items.name
string
requiredcontext.items.description
string
requiredcontext.items.items
object[]
requiredcontext.items.items.name
string
requiredcontext.items.items.description
string
requiredcontext.items.items.items
object[]
requiredcontext.items.items.items.name
string
requiredcontext.items.items.items.description
string
requiredcontext.items.items.items.items
object[]
requiredcontext.items.items.items.items.name
string
requiredcontext.items.items.items.items.description
string
requiredcontext.items.items.items.items.items
object[]
requiredcontext.items.items.items.items.items.name
string
requiredcontext.items.items.items.items.items.description
string
requiredcontext.items.items.items.items.items.items
any[]
requiredobjectives
object[]
requiredobjectives.name
string
requiredobjectives.description
string
requiredobjectives.type
enum<string>
requiredAvailable options:
string
, number
, integer
, currency
, date
, time
, enum
, boolean
, js-date-time
objectives.enum
string[]
results
object[]
results.name
string
requiredresults.value
string | null
requiredresults.type
enum<string>
requiredAvailable options:
string
, number
, integer
, currency
, date
, time
, enum
, boolean
, js-date-time
results.enum
string[]
duration_seconds
integer
curl --request POST \
--url https://api.opkit.co/v1/tasks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"script_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
"<any>"
]
}
]
}
]
}
]
}
]
}
]
}
],
"objectives": [
{
"name": "<string>",
"description": "<string>",
"type": "string",
"enum": [
"<string>"
]
}
]
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"script_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"summary": "<string>",
"customer_feedback": "<string>",
"reviewed": true,
"flagged": true,
"flagged_reason": "script_deviation",
"outcome": "success",
"created_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"context": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
{
"name": "<string>",
"description": "<string>",
"items": [
"<any>"
]
}
]
}
]
}
]
}
]
}
]
}
],
"objectives": [
{
"name": "<string>",
"description": "<string>",
"type": "string",
"enum": [
"<string>"
]
}
],
"results": [
{
"name": "<string>",
"value": "<string>",
"type": "string",
"enum": [
"<string>"
]
}
],
"duration_seconds": 123
}