{
"error": {
"type": "payment_required",
"code": "insufficient_credits",
"message": "Estimated cost $26,412.00 exceeds your balance of $18,420.55."
}
}
Missions
Create a mission
Creates a mission and dispatches its tasks to collectors in the Capibo
app. Credits are only charged as videos are accepted. Pass
"dispatch": false to create a draft you can launch later.
POST
/
missions
Create a mission
curl --request POST \ --url https://api.capibo.work/v1/missions \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "Household laundry folding", "tasks": [ { "name": "Fold t-shirt", "videos": 900, "instructions": "Fold sleeves in, then fold the shirt in thirds lengthwise.", "duration": [ 20, 45 ], "labels": [ "t-shirt", "fold", "two-hand" ] } ], "description": "Egocentric videos of people folding everyday garments for a clothes-folding robot policy.", "regions": [ "US", "PT", "MX" ], "guidelines": [ "Chest- or head-mounted phone, landscape, 1080p or higher", "Both hands visible for the whole clip" ], "dispatch": true}'
import requests
url = "https://api.capibo.work/v1/missions"
payload = {
"name": "Household laundry folding",
"tasks": [
{
"name": "Fold t-shirt",
"videos": 900,
"instructions": "Fold sleeves in, then fold the shirt in thirds lengthwise.",
"duration": [20, 45],
"labels": ["t-shirt", "fold", "two-hand"]
}
],
"description": "Egocentric videos of people folding everyday garments for a clothes-folding robot policy.",
"regions": ["US", "PT", "MX"],
"guidelines": ["Chest- or head-mounted phone, landscape, 1080p or higher", "Both hands visible for the whole clip"],
"dispatch": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Household laundry folding',
tasks: [
{
name: 'Fold t-shirt',
videos: 900,
instructions: 'Fold sleeves in, then fold the shirt in thirds lengthwise.',
duration: [20, 45],
labels: ['t-shirt', 'fold', 'two-hand']
}
],
description: 'Egocentric videos of people folding everyday garments for a clothes-folding robot policy.',
regions: ['US', 'PT', 'MX'],
guidelines: [
'Chest- or head-mounted phone, landscape, 1080p or higher',
'Both hands visible for the whole clip'
],
dispatch: true
})
};
fetch('https://api.capibo.work/v1/missions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Capibo","description":"Egocentric video data for training robots. Plan missions, review quality and pull accepted videos into your pipeline.","colors":{"primary":"#171717","light":"#F2CF5B","dark":"#171717"},"logo":{"light":"https://mintcdn.com/capibo/BUAMe73ayD114lnE/logo/light.svg?fit=max\u0026auto=format\u0026n=BUAMe73ayD114lnE\u0026q=85\u0026s=4df8cff7a406eab66438fa664e4839bf","dark":"https://mintcdn.com/capibo/BUAMe73ayD114lnE/logo/dark.svg?fit=max\u0026auto=format\u0026n=BUAMe73ayD114lnE\u0026q=85\u0026s=3bcbd2bc3dd028470e9d1ef69e360133","href":"https://capibo.work"},"favicon":"https://mintcdn.com/capibo/BUAMe73ayD114lnE/favicon.png?fit=max\u0026auto=format\u0026n=BUAMe73ayD114lnE\u0026q=85\u0026s=14928199f72712e516c90b9bcd4bc68e","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript"]}},"navbar":{"links":[{"href":"mailto:support@capibo.work","label":"Support"}],"primary":{"type":"button","label":"Open platform","href":"https://capibo.work"}},"footer":{"socials":{"website":"https://capibo.work"}},"seo":{"metatags":{"canonical":"https://docs.capibo.work"}},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"capibo","hasAudioNarration":false,"actualSubdomain":"capibo","customDomains":["docs.capibo.work"],"gitSource":{"type":"github","owner":"markusurbanpersonal","repo":"capibo-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6adcd8ba2afff40639a53be3"},"chroma":{"latestBuiltDeploymentHistoryId":"6adce60f2afff40639a84746","collectionId":"0f30aec7-adba-4957-9770-0982bc55095f","liveDeploymentHistoryId":"6adce60f2afff40639a84746","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adce60f2afff40639a84746","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API reference","count":27},{"language":"default","tag":"Documentation","count":9},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Events","count":5},{"language":"default","tag":"Missions","count":5},{"language":"default","tag":"Concepts","count":4},{"language":"default","tag":"Overview","count":3},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Billing","count":3},{"language":"default","tag":"Datasets","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/missions/create-a-mission","slug":"/api-reference/missions/create-a-mission","pageMetadata":{"title":"Create a mission","description":"Creates a mission and dispatches its tasks to collectors in the Capibo\napp. Credits are only charged as videos are accepted. Pass\n`\"dispatch\": false` to create a draft you can launch later.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /missions","href":"/api-reference/missions/create-a-mission","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Creates a mission and dispatches its tasks to collectors in the Capibo\\napp. Credits are only charged as videos are accepted. Pass\\n\", _jsx(_components.code, {\n children: \"\\\"dispatch\\\": false\"\n }), \" to create a draft you can launch later.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a mission","description":"Creates a mission and dispatches its tasks to collectors in the Capibo\napp. Credits are only charged as videos are accepted. Pass\n`\"dispatch\": false` to create a draft you can launch later.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /missions","href":"/api-reference/missions/create-a-mission","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Missions"],"summary":"Create a mission","description":"Creates a mission and dispatches its tasks to collectors in the Capibo\napp. Credits are only charged as videos are accepted. Pass\n`\"dispatch\": false` to create a draft you can launch later.\n","operationId":"createMission","parameters":["60d6da70-70b4-433b-ba69-4cc90d82f63e"],"requestBody":"35b0c73e-12ba-4ac7-8221-24412882207b","responses":{"201":"ea3b30f4-fee5-42dd-b65e-2ef591e0e322","400":"be6292f4-0aa8-47d3-82d8-31ef0e21eb90","401":"9ebf2563-0979-4759-99e9-29b0e681d6e2","402":"29e224df-c29c-414e-8912-5b7ee1b77e6b"},"method":"post","type":"path","servers":["4cef7a94-b082-4ca4-b900-18dc3b25828f"],"security":["3d04d176-19e6-4868-9f7e-c7d988e20038"],"path":"/missions","baseUrlOptions":["https://api.capibo.work/v1"],"title":"Create a mission","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"60d6da70-70b4-433b-ba69-4cc90d82f63e":{"name":"Idempotency-Key","in":"header","description":"A unique key (e.g. a UUID). Retrying with the same key returns the original response instead of doing the work twice.","schema":{"type":"string","format":"uuid","description":"A unique key (e.g. a UUID). Retrying with the same key returns the original response instead of doing the work twice.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","tasks"],"properties":{"name":{"type":"string","example":"Household laundry folding","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"tasks":{"type":"array","minItems":1,"items":{"type":"object","required":["name","videos"],"properties":{"name":{"type":"string","example":"Fold t-shirt","isRequired":true,"uniqueKey":"tasks.items.[INDEX].name","typeLabel":"string"},"videos":{"type":"integer","minimum":1,"description":"Accepted videos to collect for this task.","example":900,"isRequired":true,"uniqueKey":"tasks.items.[INDEX].videos","typeLabel":"integer"},"instructions":{"type":"string","description":"Shown to collectors in the Capibo app. Generated from `name` if omitted.","example":"Fold sleeves in, then fold the shirt in thirds lengthwise.","uniqueKey":"tasks.items.[INDEX].instructions","typeLabel":"string"},"duration":{"type":"array","description":"Target clip length in seconds, `[min, max]`.","items":{"type":"integer","uniqueKey":"tasks.items.[INDEX].duration.items.[INDEX]","typeLabel":"integer"},"minItems":2,"maxItems":2,"example":[20,45],"uniqueKey":"tasks.items.[INDEX].duration","typeLabel":"integer[]"},"labels":{"type":"array","items":{"type":"string","uniqueKey":"tasks.items.[INDEX].labels.items.[INDEX]","typeLabel":"string"},"example":["t-shirt","fold","two-hand"],"uniqueKey":"tasks.items.[INDEX].labels","typeLabel":"string[]"}},"uniqueKey":"tasks.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"tasks","typeLabel":"object[]"},"description":{"type":"string","example":"Egocentric videos of people folding everyday garments for a clothes-folding robot policy.","uniqueKey":"description","typeLabel":"string"},"regions":{"type":"array","items":{"type":"string","description":"ISO 3166-1 alpha-2 country code (UK for the United Kingdom).","enum":["US","CA","MX","BR","UK","DE","ES","PT","PL","IN"],"uniqueKey":"regions.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["US","PT","MX"],"uniqueKey":"regions","typeLabel":"enum\u003cstring>[]"},"guidelines":{"type":"array","description":"Recording rules applied to every task.","items":{"type":"string","uniqueKey":"guidelines.items.[INDEX]","typeLabel":"string"},"example":["Chest- or head-mounted phone, landscape, 1080p or higher","Both hands visible for the whole clip"],"uniqueKey":"guidelines","typeLabel":"string[]"},"dispatch":{"type":"boolean","default":true,"description":"Send tasks to collectors immediately. `false` creates a `draft`.","uniqueKey":"dispatch","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"Household laundry folding","tasks":[{"name":"Fold t-shirt","videos":900,"instructions":"Fold sleeves in, then fold the shirt in thirds lengthwise.","duration":[20,45],"labels":["t-shirt","fold","two-hand"]}],"description":"Egocentric videos of people folding everyday garments for a clothes-folding robot policy.","regions":["US","PT","MX"],"guidelines":["Chest- or head-mounted phone, landscape, 1080p or higher","Both hands visible for the whole clip"],"dispatch":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ea3b30f4-fee5-42dd-b65e-2ef591e0e322":{"description":"The created mission.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"MSN-1042","uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","example":"Household laundry folding","uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"status":{"type":"string","enum":["draft","dispatching","active","paused","completed"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"regions":{"type":"array","items":{"type":"string","description":"ISO 3166-1 alpha-2 country code (UK for the United Kingdom).","enum":["US","CA","MX","BR","UK","DE","ES","PT","PL","IN"],"uniqueKey":"regions.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"regions","typeLabel":"enum\u003cstring>[]"},"target":{"type":"integer","description":"Accepted videos to collect across all tasks.","example":10000,"uniqueKey":"target","typeLabel":"integer"},"accepted":{"type":"integer","example":7339,"uniqueKey":"accepted","typeLabel":"integer"},"progress":{"type":"integer","description":"Percent of target accepted.","example":73,"uniqueKey":"progress","typeLabel":"integer"},"cost":{"type":"number","description":"USD charged so far.","example":24783.4,"uniqueKey":"cost","typeLabel":"number"},"tasks":{"type":"array","items":{"type":"object","required":["name","videos"],"properties":{"name":{"type":"string","example":"Fold t-shirt","isRequired":true,"uniqueKey":"tasks.items.[INDEX].name","typeLabel":"string"},"videos":{"type":"integer","minimum":1,"description":"Accepted videos to collect for this task.","example":900,"isRequired":true,"uniqueKey":"tasks.items.[INDEX].videos","typeLabel":"integer"},"instructions":{"type":"string","description":"Shown to collectors in the Capibo app. Generated from `name` if omitted.","example":"Fold sleeves in, then fold the shirt in thirds lengthwise.","uniqueKey":"tasks.items.[INDEX].instructions","typeLabel":"string"},"duration":{"type":"array","description":"Target clip length in seconds, `[min, max]`.","items":{"type":"integer","uniqueKey":"tasks.items.[INDEX].duration.items.[INDEX]","typeLabel":"integer"},"minItems":2,"maxItems":2,"example":[20,45],"uniqueKey":"tasks.items.[INDEX].duration","typeLabel":"integer[]"},"labels":{"type":"array","items":{"type":"string","uniqueKey":"tasks.items.[INDEX].labels.items.[INDEX]","typeLabel":"string"},"example":["t-shirt","fold","two-hand"],"uniqueKey":"tasks.items.[INDEX].labels","typeLabel":"string[]"},"id":{"type":"string","example":"T-2","uniqueKey":"tasks.items.[INDEX].id","typeLabel":"string"},"price":{"type":"number","description":"USD per accepted video.","example":3.19,"uniqueKey":"tasks.items.[INDEX].price","typeLabel":"number"},"accepted":{"type":"integer","example":1612,"uniqueKey":"tasks.items.[INDEX].accepted","typeLabel":"integer"}},"uniqueKey":"tasks.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tasks","typeLabel":"object[]"},"dataset_id":{"oneOf":[{"type":"string","description":"Set once the first video is accepted.","example":"DS-301","uniqueKey":"dataset_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Set once the first video is accepted.","example":"DS-301","uniqueKey":"dataset_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"dataset_id","typeLabel":"string | null"},"started_at":{"type":"string","format":"date-time","uniqueKey":"started_at","typeLabel":"string\u003cdate-time>"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"completed_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"MSN-1042","name":"Household laundry folding","description":"\u003cstring>","status":"draft","regions":["US"],"target":10000,"accepted":7339,"progress":73,"cost":24783.4,"tasks":[{"name":"Fold t-shirt","videos":900,"instructions":"Fold sleeves in, then fold the shirt in thirds lengthwise.","duration":[20,45],"labels":["t-shirt","fold","two-hand"],"id":"T-2","price":3.19,"accepted":1612}],"dataset_id":"DS-301","started_at":"2023-11-07T05:31:56Z","completed_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"be6292f4-0aa8-47d3-82d8-31ef0e21eb90":{"description":"The request is invalid.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["invalid_request","authentication_error","permission_denied","not_found","conflict","payment_required","rate_limited","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Machine-readable reason.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error","if any.":null,"uniqueKey":"error.param","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"invalid_request","code":"parameter_invalid","message":"tasks[0].videos must be at least 1.","param":"tasks[0].videos"}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request","code":"parameter_invalid","message":"tasks[0].videos must be at least 1.","param":"tasks[0].videos"}}}},"exampleType":"examples"}},"exampleType":"examples"},"9ebf2563-0979-4759-99e9-29b0e681d6e2":{"description":"The API key is missing, invalid or revoked.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["invalid_request","authentication_error","permission_denied","not_found","conflict","payment_required","rate_limited","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Machine-readable reason.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error","if any.":null,"uniqueKey":"error.param","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"authentication_error","code":"api_key_invalid","message":"Invalid API key."}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"authentication_error","code":"api_key_invalid","message":"Invalid API key."}}}},"exampleType":"examples"}},"exampleType":"examples"},"29e224df-c29c-414e-8912-5b7ee1b77e6b":{"description":"Your balance doesn't cover the mission's estimated cost.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["invalid_request","authentication_error","permission_denied","not_found","conflict","payment_required","rate_limited","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Machine-readable reason.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error","if any.":null,"uniqueKey":"error.param","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"payment_required","code":"insufficient_credits","message":"Estimated cost $26,412.00 exceeds your balance of $18,420.55."}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"payment_required","code":"insufficient_credits","message":"Estimated cost $26,412.00 exceeds your balance of $18,420.55."}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"3d04d176-19e6-4868-9f7e-c7d988e20038":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key from **Settings → API keys**, e.g. `cpb_live_…` or `cpb_test_…`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"4cef7a94-b082-4ca4-b900-18dc3b25828f":{"url":"https://api.capibo.work/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key from **Settings → API keys**, e.g. `cpb_live_…` or `cpb_test_…`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key from **Settings → API keys**, e.g. `cpb_live_…` or `cpb_test_…`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"capibo","siteName":"Capibo","title":"Create a mission - Capibo","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-24T16:12:18.122Z","originalFileLocation":"api-reference/missions/create-a-mission.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a mission and dispatches its tasks to collectors in the Capibo app. Credits are only charged as videos are accepted. Pass \u0026quot;dispatch\u0026quot;: false to create a draft you can launch later.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Capibo\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/capibo/xBlsiiyNuoVD0Qae/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/capibo/xBlsiiyNuoVD0Qae/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/capibo/xBlsiiyNuoVD0Qae/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/capibo/xBlsiiyNuoVD0Qae/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/capibo/xBlsiiyNuoVD0Qae/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/capibo/xBlsiiyNuoVD0Qae/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/capibo/xBlsiiyNuoVD0Qae/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/capibo/xBlsiiyNuoVD0Qae/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/capibo/xBlsiiyNuoVD0Qae/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a mission - Capibo\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a mission and dispatches its tasks to collectors in the Capibo app. Credits are only charged as videos are accepted. Pass \u0026quot;dispatch\u0026quot;: false to create a draft you can launch later.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Capibo\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.capibo.work/api-reference/missions/create-a-mission\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://capibo.mintlify.app/_mintlify/api/og/v2?division=Missions\u0026amp;title=Create+a+mission\u0026amp;description=Creates+a+mission+and+dispatches+its+tasks+to+collectors+in+the+Capibo%0Aapp.+Credits+are+only+charged+as+videos+are+accepted.+Pass%0A%60%22dispatch%22%3A+false%60+to+create+\u0026amp;theme=4a01392e0376e7155567335f\u0026amp;signature=57e16b8968f05f3beeacb2ef93630326b6d92865d11bc40fff00bd3204c501cd\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a mission - Capibo\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a mission and dispatches its tasks to collectors in the Capibo app. Credits are only charged as videos are accepted. Pass \u0026quot;dispatch\u0026quot;: false to create a draft you can launch later.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://capibo.mintlify.app/_mintlify/api/og/v2?division=Missions\u0026amp;title=Create+a+mission\u0026amp;description=Creates+a+mission+and+dispatches+its+tasks+to+collectors+in+the+Capibo%0Aapp.+Credits+are+only+charged+as+videos+are+accepted.+Pass%0A%60%22dispatch%22%3A+false%60+to+create+\u0026amp;theme=4a01392e0376e7155567335f\u0026amp;signature=57e16b8968f05f3beeacb2ef93630326b6d92865d11bc40fff00bd3204c501cd\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/capibo/xBlsiiyNuoVD0Qae/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Capibo\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#171717\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.capibo.work/api-reference/missions/create-a-mission\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/missions/create-a-mission.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.capibo.work/#organization\",\"name\":\"Capibo\",\"url\":\"https://docs.capibo.work\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/capibo/BUAMe73ayD114lnE/logo/light.svg?fit=max\u0026auto=format\u0026n=BUAMe73ayD114lnE\u0026q=85\u0026s=4df8cff7a406eab66438fa664e4839bf\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.capibo.work#website\",\"name\":\"Capibo\",\"url\":\"https://docs.capibo.work\",\"publisher\":{\"@id\":\"https://docs.capibo.work/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.capibo.work/api-reference/missions/create-a-mission#webpage\",\"url\":\"https://docs.capibo.work/api-reference/missions/create-a-mission\",\"name\":\"Create a mission\",\"description\":\"Creates a mission and dispatches its tasks to collectors in the Capibo app. Credits are only charged as videos are accepted. Pass \\\"dispatch\\\": false to create a draft you can launch later.\",\"dateModified\":\"2026-10-24T16:12:18.122Z\",\"isPartOf\":{\"@id\":\"https://docs.capibo.work#website\"},\"breadcrumb\":{\"@id\":\"https://docs.capibo.work/api-reference/missions/create-a-mission#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.capibo.work/api-reference/missions/create-a-mission#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Missions\",\"item\":\"https://docs.capibo.work/api-reference/missions/list-missions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a mission\",\"item\":\"https://docs.capibo.work/api-reference/missions/create-a-mission\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.capibo.work/api-reference/missions/create-a-mission#apireference\",\"headline\":\"Create a mission\",\"name\":\"Create a mission\",\"description\":\"Creates a mission and dispatches its tasks to collectors in the Capibo app. Credits are only charged as videos are accepted. Pass \\\"dispatch\\\": false to create a draft you can launch later.\",\"url\":\"https://docs.capibo.work/api-reference/missions/create-a-mission\",\"mainEntityOfPage\":{\"@id\":\"https://docs.capibo.work/api-reference/missions/create-a-mission#webpage\"},\"dateModified\":\"2026-10-24T16:12:18.122Z\",\"publisher\":{\"@id\":\"https://docs.capibo.work/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.capibo.work#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Capibo\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Capibo","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","icon":"braces","href":"/api-reference/introduction"},{"title":"Errors","icon":"triangle-alert","href":"/api-reference/errors"},{"title":"Pagination","icon":"list-ordered","href":"/api-reference/pagination"}]},{"group":"Missions","pages":[{"title":"List missions","description":null,"deprecated":null,"version":null,"openapi":"/openapi.yaml get /missions","href":"/api-reference/missions/list-missions"},{"title":"Create a mission","deprecated":null,"version":null,"openapi":"/openapi.yaml post /missions","href":"/api-reference/missions/create-a-mission"},{"title":"Retrieve a mission","description":null,"deprecated":null,"version":null,"openapi":"/openapi.yaml get /missions/{mission_id}","href":"/api-reference/missions/retrieve-a-mission"},{"title":"Update a mission","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /missions/{mission_id}","href":"/api-reference/missions/update-a-mission"},{"title":"Retrieve mission stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /missions/{mission_id}/stats","href":"/api-reference/missions/retrieve-mission-stats"}]},{"group":"Planning","pages":[{"title":"Estimate a mission","deprecated":null,"version":null,"openapi":"/openapi.yaml post /missions/estimate","href":"/api-reference/planning/estimate-a-mission"}]},{"group":"Datasets","pages":[{"title":"List datasets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /datasets","href":"/api-reference/datasets/list-datasets"},{"title":"Retrieve a dataset","deprecated":null,"version":null,"openapi":"/openapi.yaml get /datasets/{dataset_id}","href":"/api-reference/datasets/retrieve-a-dataset"},{"title":"List dataset videos","deprecated":null,"version":null,"openapi":"/openapi.yaml get /datasets/{dataset_id}/videos","href":"/api-reference/datasets/list-dataset-videos"}]},{"group":"Videos","pages":[{"title":"Retrieve a video","deprecated":null,"version":null,"openapi":"/openapi.yaml get /videos/{video_id}","href":"/api-reference/videos/retrieve-a-video"}]},{"group":"Exports","pages":[{"title":"Create an export","deprecated":null,"version":null,"openapi":"/openapi.yaml post /datasets/{dataset_id}/exports","href":"/api-reference/exports/create-an-export"},{"title":"Retrieve an export","deprecated":null,"version":null,"openapi":"/openapi.yaml get /exports/{export_id}","href":"/api-reference/exports/retrieve-an-export"}]},{"group":"Billing","pages":[{"title":"Retrieve credit balance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /billing/balance","href":"/api-reference/billing/retrieve-credit-balance"},{"title":"List transactions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /billing/transactions","href":"/api-reference/billing/list-transactions"},{"title":"Redeem a promo code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /billing/promo-codes/redeem","href":"/api-reference/billing/redeem-a-promo-code"}]},{"group":"Usage","pages":[{"title":"Retrieve usage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /usage","href":"/api-reference/usage/retrieve-usage"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /webhooks/{webhook_id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"group":"Events","pages":[{"title":"video.accepted","openapi":"openapi.yaml webhook video.accepted","icon":"circle-check","href":"/api-reference/events/video-accepted"},{"title":"video.rejected","openapi":"openapi.yaml webhook video.rejected","icon":"circle-x","href":"/api-reference/events/video-rejected"},{"title":"mission.completed","openapi":"openapi.yaml webhook mission.completed","icon":"flag","href":"/api-reference/events/mission-completed"},{"title":"export.ready","openapi":"openapi.yaml webhook export.ready","icon":"package-check","href":"/api-reference/events/export-ready"},{"title":"balance.low","openapi":"openapi.yaml webhook balance.low","icon":"battery-low","href":"/api-reference/events/balance-low"}]}]}]}]},"title":"Create a mission - Capibo","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}