{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Nimble Docs","colors":{"primary":"#edc602","light":"#edc602","dark":"#edc602"},"logo":{"light":"https://mintcdn.com/nimble-f5a8283f/o--9pIuMkGtkmWwc/images/light.svg?fit=max\u0026auto=format\u0026n=o--9pIuMkGtkmWwc\u0026q=85\u0026s=4f01d3ff0f6702dfa400db4d8d46d71a","dark":"https://mintcdn.com/nimble-f5a8283f/o--9pIuMkGtkmWwc/images/dark.svg?fit=max\u0026auto=format\u0026n=o--9pIuMkGtkmWwc\u0026q=85\u0026s=884461c581a8cd728bd01f0887180dc4","href":"https://www.nimbleway.com"},"favicon":"https://mintcdn.com/nimble-f5a8283f/p44s6zCqqsFm92lY/images/favicon.png?fit=max\u0026auto=format\u0026n=p44s6zCqqsFm92lY\u0026q=85\u0026s=2c068e67e4853cc4e392c1f9e65d8766","api":{"playground":{"display":"interactive","proxy":true}},"appearance":{"default":"dark","strict":true},"navbar":{"links":[{"href":"https://portal.usepylon.com/nimble","label":"Support"},{"href":"https://nimbleway.com/contact-general/","label":"Book a Demo"}],"primary":{"type":"button","label":"Ask Nimble","href":"https://online.nimbleway.com/workflow-builder"}},"footer":{"socials":{"website":"https://www.nimbleway.com/","linkedin":"https://www.linkedin.com/company/nimbledata","x":"https://x.com/nimble_search"}},"seo":{"indexing":"navigable"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":true},"integrations":{"posthog":{"apiKey":"phc_WSssX85HFXGf9WkKvKgjHR80zijmy5KLO3HdyiSMY3S","apiHost":"https://x.nimbleway.com","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","grok","mcp","add-mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Ask Nimble","icon":"wand-magic-sparkles","color":{"light":"#edc602","dark":"#edc602"},"href":"https://online.nimbleway.com/workflow-builder"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nimble-f5a8283f","hasAudioNarration":false,"actualSubdomain":"nimble-f5a8283f","customDomains":["docs.nimbleway.com"],"gitSource":{"type":"github","owner":"nimbleway","repo":"public-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aec6808f73278e025986da5","collectionId":"d1de0c7b-6920-41b8-87b7-09e22545d9d6","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aec6808f73278e025986da5"},"feedback":{"thumbs":true,"issues":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aec6808f73278e025986da5","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Integrations","count":72},{"language":"default","tag":"Documentation","count":64},{"language":"default","tag":"API Reference","count":60},{"language":"default","tag":"Proxy","count":22},{"language":"default","tag":"Connectors","count":16},{"language":"default","tag":"Agent","count":16},{"language":"default","tag":"Extraction Tools","count":16},{"language":"default","tag":"Partnerships","count":13},{"language":"default","tag":"Extract","count":13},{"language":"default","tag":"Jobs API","count":13}]},"assistantConfig":{"enableStarterQuestions":false,"deflection":{"enabled":true,"email":"[email protected]","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/jobs/create-job","slug":"/api-reference/jobs/create-job","pageMetadata":{"title":"Create Job","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/jobs","href":"/api-reference/jobs/create-job","autogeneratedByOpenApi":true},"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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Create Job","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/jobs","href":"/api-reference/jobs/create-job","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"create_job_public_v2_api_v2_public_jobs_post","requestBody":"d1c8eaf7-e3aa-49a5-97b5-8d5060d1122b","responses":{"201":"22692478-7079-4bc9-b7fd-48fbc0a50f25","422":"87c7d2a2-86f7-4788-94f7-e0e7ee7ff736"},"security":["f910dd10-b3f3-4135-a52a-f12d0ac74762"],"summary":"Create Job","tags":["Jobs"],"method":"post","type":"path","servers":["94215351-4ba3-47f3-9faf-4efb79cb10de"],"path":"/v2/jobs","baseUrlOptions":["https://sdk.nimbleway.com"],"title":"Create Job","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"description":"Payload to create a new job.","properties":{"extract_template_name":{"description":"Name of the extract template to run.","title":"Extract Template Name","type":"string","isRequired":true,"uniqueKey":"extract_template_name","typeLabel":"string"},"name":{"description":"Job name.","title":"Name","type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","title":"Description","description":"Free-text description of the job.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","description":"Free-text description of the job.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"destination":{"oneOf":[{"type":"object","title":"JobDestinationPublicV2","description":"Where the job writes its results.","required":["type","path"],"properties":{"path":{"description":"Destination path the output is written to.","title":"Path","type":"string","isRequired":true,"uniqueKey":"destination.oneOf.0.path","typeLabel":"string"},"type":{"description":"Destination kind: a local 'file' or an 's3' bucket.","enum":["file","s3"],"title":"Type","type":"string","isRequired":true,"uniqueKey":"destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"format":{"default":"parquet","description":"Output file format.","enum":["jsonl","csv","parquet"],"title":"Format","type":"string","uniqueKey":"destination.oneOf.0.format","typeLabel":"enum\u003cstring>"}},"uniqueKey":"destination.oneOf.0","typeLabel":"JobDestinationPublicV2 · object"},{"type":"null","description":"Where the job writes its results.","uniqueKey":"destination.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination","typeLabel":"JobDestinationPublicV2 · object | null"},"display_name":{"oneOf":[{"type":"string","title":"Display Name","description":"Human-friendly job name shown in the UI.","uniqueKey":"display_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Display Name","description":"Human-friendly job name shown in the UI.","uniqueKey":"display_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"display_name","typeLabel":"string | null"},"inputs":{"oneOf":[{"type":"object","title":"JobInputsPublicV2","description":"Input data configuration for the job.","required":["type"],"properties":{"type":{"description":"How inputs are supplied: an 's3' bucket, 'inline' records, or an uploaded 'file'.","enum":["s3","inline","file"],"title":"Type","type":"string","isRequired":true,"uniqueKey":"inputs.oneOf.0.type","typeLabel":"enum\u003cstring>"},"data":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"inputs.oneOf.0.data.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Data","description":"Inline list of input records. Used when type is 'inline'.","uniqueKey":"inputs.oneOf.0.data.oneOf.0","typeLabel":"Data · object[]"},{"type":"null","title":"Data","description":"Inline list of input records. Used when type is 'inline'.","uniqueKey":"inputs.oneOf.0.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"inputs.oneOf.0.data","typeLabel":"Data · object[] | null"},"file_path":{"oneOf":[{"type":"string","title":"File Path","description":"Path to the input file; must start with 's3' or 'file_'. Used for 's3'/'file' types.","uniqueKey":"inputs.oneOf.0.file_path.oneOf.0","typeLabel":"string"},{"type":"null","title":"File Path","description":"Path to the input file; must start with 's3' or 'file_'. Used for 's3'/'file' types.","uniqueKey":"inputs.oneOf.0.file_path.oneOf.1","typeLabel":"null"}],"uniqueKey":"inputs.oneOf.0.file_path","typeLabel":"string | null"}},"uniqueKey":"inputs.oneOf.0","typeLabel":"JobInputsPublicV2 · object"},{"type":"null","description":"Input data configuration for the job.","uniqueKey":"inputs.oneOf.1","typeLabel":"null"}],"uniqueKey":"inputs","typeLabel":"JobInputsPublicV2 · object | null"},"schedule":{"oneOf":[{"type":"object","title":"JobSchedulePublicV2","description":"Cron schedule controlling automatic runs.","required":["cron","enabled"],"properties":{"cron":{"description":"Cron expression defining when the job runs.","title":"Cron","type":"string","isRequired":true,"uniqueKey":"schedule.oneOf.0.cron","typeLabel":"string"},"enabled":{"description":"Whether the schedule is currently active.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"schedule.oneOf.0.enabled","typeLabel":"boolean"}},"uniqueKey":"schedule.oneOf.0","typeLabel":"JobSchedulePublicV2 · object"},{"type":"null","description":"Cron schedule controlling automatic runs.","uniqueKey":"schedule.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule","typeLabel":"JobSchedulePublicV2 · object | null"}},"required":["name","extract_template_name"],"title":"CreateJobRequestPublicV2","type":"object","uniqueKey":"","typeLabel":"CreateJobRequestPublicV2 · object"},"examples":{"Example":{"title":"Example","value":{"extract_template_name":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","destination":{"path":"\u003cstring>","format":"parquet"},"display_name":"\u003cstring>","inputs":{"data":[{}],"file_path":"\u003cstring>"},"schedule":{"cron":"\u003cstring>","enabled":true}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"22692478-7079-4bc9-b7fd-48fbc0a50f25":{"content":{"application/json":{"schema":{"description":"A configured job: an agent plus its schedule, inputs, and destination.","properties":{"id":{"description":"Unique job identifier (job_\u003cn>).","pattern":"^job_[1-9][0-9]*$","title":"Id","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"description":"Job name.","title":"Name","type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","title":"Created At","description":"When the job was created.","format":"date-time","uniqueKey":"created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At","description":"When the job was created.","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","title":"Description","description":"Free-text description of the job.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","description":"Free-text description of the job.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"destination":{"oneOf":[{"type":"object","title":"JobDestinationPublicV2","description":"Where the job writes its results.","required":["type","path"],"properties":{"path":{"description":"Destination path the output is written to.","title":"Path","type":"string","isRequired":true,"uniqueKey":"destination.oneOf.0.path","typeLabel":"string"},"type":{"description":"Destination kind: a local 'file' or an 's3' bucket.","enum":["file","s3"],"title":"Type","type":"string","isRequired":true,"uniqueKey":"destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"format":{"default":"parquet","description":"Output file format.","enum":["jsonl","csv","parquet"],"title":"Format","type":"string","uniqueKey":"destination.oneOf.0.format","typeLabel":"enum\u003cstring>"}},"uniqueKey":"destination.oneOf.0","typeLabel":"JobDestinationPublicV2 · object"},{"type":"null","description":"Where the job writes its results.","uniqueKey":"destination.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination","typeLabel":"JobDestinationPublicV2 · object | null"},"display_name":{"oneOf":[{"type":"string","title":"Display Name","description":"Human-friendly job name shown in the UI.","uniqueKey":"display_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Display Name","description":"Human-friendly job name shown in the UI.","uniqueKey":"display_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"display_name","typeLabel":"string | null"},"extract_template_name":{"oneOf":[{"type":"string","title":"Extract Template Name","description":"Name of the extract template this job runs.","uniqueKey":"extract_template_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Extract Template Name","description":"Name of the extract template this job runs.","uniqueKey":"extract_template_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"extract_template_name","typeLabel":"string | null"},"inputs":{"oneOf":[{"type":"object","title":"JobInputsPublicV2","description":"Input data configuration for the job.","required":["type"],"properties":{"type":{"description":"How inputs are supplied: an 's3' bucket, 'inline' records, or an uploaded 'file'.","enum":["s3","inline","file"],"title":"Type","type":"string","isRequired":true,"uniqueKey":"inputs.oneOf.0.type","typeLabel":"enum\u003cstring>"},"data":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"inputs.oneOf.0.data.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Data","description":"Inline list of input records. Used when type is 'inline'.","uniqueKey":"inputs.oneOf.0.data.oneOf.0","typeLabel":"Data · object[]"},{"type":"null","title":"Data","description":"Inline list of input records. Used when type is 'inline'.","uniqueKey":"inputs.oneOf.0.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"inputs.oneOf.0.data","typeLabel":"Data · object[] | null"},"file_path":{"oneOf":[{"type":"string","title":"File Path","description":"Path to the input file; must start with 's3' or 'file_'. Used for 's3'/'file' types.","uniqueKey":"inputs.oneOf.0.file_path.oneOf.0","typeLabel":"string"},{"type":"null","title":"File Path","description":"Path to the input file; must start with 's3' or 'file_'. Used for 's3'/'file' types.","uniqueKey":"inputs.oneOf.0.file_path.oneOf.1","typeLabel":"null"}],"uniqueKey":"inputs.oneOf.0.file_path","typeLabel":"string | null"}},"uniqueKey":"inputs.oneOf.0","typeLabel":"JobInputsPublicV2 · object"},{"type":"null","description":"Input data configuration for the job.","uniqueKey":"inputs.oneOf.1","typeLabel":"null"}],"uniqueKey":"inputs","typeLabel":"JobInputsPublicV2 · object | null"},"last_run_at":{"oneOf":[{"type":"string","title":"Last Run At","description":"Timestamp of the most recent run.","format":"date-time","uniqueKey":"last_run_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Run At","description":"Timestamp of the most recent run.","uniqueKey":"last_run_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_run_at","typeLabel":"string\u003cdate-time> | null"},"last_run_status":{"oneOf":[{"type":"string","title":"Last Run Status","description":"Status of the most recent run.","enum":["PENDING","RUNNING","SUCCESS","FAILED","CANCELLED","TIMEOUT","WARNING"],"uniqueKey":"last_run_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Last Run Status","description":"Status of the most recent run.","uniqueKey":"last_run_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_run_status","typeLabel":"enum\u003cstring> | null"},"schedule":{"oneOf":[{"type":"object","title":"JobSchedulePublicV2","description":"Cron schedule controlling automatic runs.","required":["cron","enabled"],"properties":{"cron":{"description":"Cron expression defining when the job runs.","title":"Cron","type":"string","isRequired":true,"uniqueKey":"schedule.oneOf.0.cron","typeLabel":"string"},"enabled":{"description":"Whether the schedule is currently active.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"schedule.oneOf.0.enabled","typeLabel":"boolean"}},"uniqueKey":"schedule.oneOf.0","typeLabel":"JobSchedulePublicV2 · object"},{"type":"null","description":"Cron schedule controlling automatic runs.","uniqueKey":"schedule.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule","typeLabel":"JobSchedulePublicV2 · object | null"},"updated_at":{"oneOf":[{"type":"string","title":"Updated At","description":"When the job was last updated.","format":"date-time","uniqueKey":"updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Updated At","description":"When the job was last updated.","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["id","name"],"title":"JobPublicV2","type":"object","uniqueKey":"","typeLabel":"JobPublicV2 · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","description":"\u003cstring>","destination":{"path":"\u003cstring>","type":"file","format":"parquet"},"display_name":"\u003cstring>","extract_template_name":"\u003cstring>","inputs":{"type":"s3","data":[{}],"file_path":"\u003cstring>"},"last_run_at":"2023-11-07T05:31:56Z","last_run_status":"PENDING","schedule":{"cron":"\u003cstring>","enabled":true},"updated_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"87c7d2a2-86f7-4788-94f7-e0e7ee7ff736":{"content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"title":"Location","type":"array","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"title":"Error Type","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"ctx":{"title":"Context","type":"object","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"title":"Detail","type":"array","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"title":"HTTPValidationError","type":"object","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","ctx":{},"input":"\u003cunknown>"}]}}},"exampleType":"generated"}},"description":"Validation Error","exampleType":"generated"}},"security":{"f910dd10-b3f3-4135-a52a-f12d0ac74762":{"BearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"94215351-4ba3-47f3-9faf-4efb79cb10de":{"url":"https://sdk.nimbleway.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"nimble-f5a8283f","siteName":"Nimble Docs","title":"Create Job - Nimble Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T11:27:09.190Z","originalFileLocation":"api-reference/jobs/create-job.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";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=\"dark\"}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=\"application-name\" content=\"Nimble Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Job - Nimble Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nimble Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.nimbleway.com/api-reference/jobs/create-job\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nimble-f5a8283f.mintlify.site/_mintlify/api/og/v2?division=Jobs+API\u0026amp;title=Create+Job\u0026amp;theme=e511cdab2c346c886a5a73f0\u0026amp;signature=b9679c81047104202e3c13d2e5f2abb8d8067bb7baa1ae41212ddabc5f0f3a7e\">\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 Job - Nimble Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nimble-f5a8283f.mintlify.site/_mintlify/api/og/v2?division=Jobs+API\u0026amp;title=Create+Job\u0026amp;theme=e511cdab2c346c886a5a73f0\u0026amp;signature=b9679c81047104202e3c13d2e5f2abb8d8067bb7baa1ae41212ddabc5f0f3a7e\">\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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nimble Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#edc602\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.nimbleway.com/api-reference/jobs/create-job\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/jobs/create-job.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.nimbleway.com/#organization\",\"name\":\"Nimble Docs\",\"url\":\"https://docs.nimbleway.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nimble-f5a8283f/o--9pIuMkGtkmWwc/images/light.svg?fit=max\u0026auto=format\u0026n=o--9pIuMkGtkmWwc\u0026q=85\u0026s=4f01d3ff0f6702dfa400db4d8d46d71a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.nimbleway.com#website\",\"name\":\"Nimble Docs\",\"url\":\"https://docs.nimbleway.com\",\"publisher\":{\"@id\":\"https://docs.nimbleway.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.nimbleway.com/api-reference/jobs/create-job#webpage\",\"url\":\"https://docs.nimbleway.com/api-reference/jobs/create-job\",\"name\":\"Create Job\",\"dateModified\":\"2026-11-05T11:27:09.190Z\",\"isPartOf\":{\"@id\":\"https://docs.nimbleway.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nimbleway.com/api-reference/jobs/create-job#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nimbleway.com/api-reference/jobs/create-job#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Nimble Docs\",\"item\":\"https://docs.nimbleway.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Job\",\"item\":\"https://docs.nimbleway.com/api-reference/jobs/create-job\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.nimbleway.com/api-reference/jobs/create-job#apireference\",\"headline\":\"Create Job\",\"name\":\"Create Job\",\"url\":\"https://docs.nimbleway.com/api-reference/jobs/create-job\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nimbleway.com/api-reference/jobs/create-job#webpage\"},\"dateModified\":\"2026-11-05T11:27:09.190Z\",\"publisher\":{\"@id\":\"https://docs.nimbleway.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.nimbleway.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nimble Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Nimble Docs","nav":{"global":{"anchors":[{"anchor":"Ask Nimble","icon":"wand-magic-sparkles","color":{"light":"#edc602","dark":"#edc602"},"href":"https://online.nimbleway.com/workflow-builder"}]},"tabs":[{"tab":"Home","icon":"house-blank","pages":[{"title":"Home","href":"/home"}]},{"tab":"Hackathon","hidden":true,"pages":[{"title":"Hackathon","href":"/hackathon"}]},{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/nimble-sdk/getting-started/overview"}]},{"tab":"Nimble Platform","hidden":true,"pages":[{"title":"Nimble Platform","href":"/nimble-platform/agents/managed-agents"}]},{"tab":"Integrations","icon":"link-horizontal","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"API Reference","icon":"code","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"group":"Search API","icon":"magnifying-glass","pages":[{"title":"Search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/search","href":"/api-reference/search/search"}]},{"group":"Agents API","icon":"bullseye-pointer","tag":"NEW","pages":[{"title":"Create Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/agents/runs","href":"/api-reference/public-api/create-run"},{"title":"Create Agent Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/agents/{agent_id}/runs","href":"/api-reference/public-api/create-agent-run"},{"title":"Get Agent Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/{agent_id}/runs/{run_id}","href":"/api-reference/public-api/get-agent-run"},{"title":"Get Agent Run Result","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/{agent_id}/runs/{run_id}/result","href":"/api-reference/public-api/get-agent-run-result"},{"title":"Stream Agent Run Events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/{agent_id}/runs/{run_id}/events","href":"/api-reference/public-api/stream-agent-run-events"},{"title":"List Agent Runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/{agent_id}/runs","href":"/api-reference/public-api/list-agent-runs"},{"title":"Create Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/agents","href":"/api-reference/public-api/create-agent"},{"title":"List Agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents","href":"/api-reference/public-api/list-agents"},{"title":"Get Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/{agent_id}","href":"/api-reference/public-api/get-agent"},{"title":"Update Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v2/agents/{agent_id}","href":"/api-reference/public-api/update-agent"},{"title":"Deactivate Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/agents/{agent_id}","href":"/api-reference/public-api/deactivate-agent"},{"title":"List Agent Templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/templates","href":"/api-reference/public-api/list-agent-templates"},{"title":"Get Agent Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/templates/{template_name}","href":"/api-reference/public-api/get-agent-template"}]},{"group":"Extract API","icon":"arrows-to-circle","pages":[{"title":"Extract","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract","href":"/api-reference/extract/extract"},{"title":"Extract Async","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/async","href":"/api-reference/extract/extract-async"},{"title":"Extract Batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/batch","href":"/api-reference/extract/extract-batch"}]},{"group":"Extract Templates API","icon":"table-cells","tag":"NEW","pages":[{"title":"Run Extract Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/templates/run","href":"/api-reference/extract-templates-api/run-extract-template"},{"title":"Run Extract Template (Async)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/templates/async","href":"/api-reference/extract-templates-api/run-extract-template-async"},{"title":"Run Extract Template (Batch)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/templates/batch","href":"/api-reference/extract-templates-api/run-extract-template-batch"},{"title":"List Extract Templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/extract/templates","href":"/api-reference/extract-templates-api/list-extract-templates"},{"title":"Get Extract Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/extract/templates/{extract_template_name}","href":"/api-reference/extract-templates-api/get-extract-template"},{"title":"Update Extract Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v2/extract/templates/{extract_template_name}","href":"/api-reference/extract-templates-api/update-extract-template"},{"title":"Delete Extract Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/extract/templates/{extract_template_name}","href":"/api-reference/extract-templates-api/delete-extract-template"},{"title":"List Extract Template Versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/extract/templates/{extract_template_name}/versions","href":"/api-reference/extract-templates-api/list-extract-template-versions"},{"title":"Get Extract Template Version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/extract/templates/{extract_template_name}/versions/{version_id}","href":"/api-reference/extract-templates-api/get-extract-template-version"},{"title":"Create Extract Template Generation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/templates/generations","href":"/api-reference/extract-templates-api/create-extract-template-generation"},{"title":"Get Extract Template Generation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/extract/templates/generations/{generation_id}","href":"/api-reference/extract-templates-api/get-extract-template-generation"}]},{"group":"Map API","icon":"sitemap","pages":[{"title":"Map","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/map","href":"/api-reference/map/map"}]},{"group":"Crawl API","icon":"spider","pages":[{"title":"Create Crawl","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/crawl","href":"/api-reference/crawl/create-crawl"},{"title":"List Crawls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/crawl","href":"/api-reference/crawl/list-crawls"},{"title":"Crawl by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/crawl/{id}","href":"/api-reference/crawl/crawl-by-id"},{"title":"Cancel Crawl","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/crawl/{id}","href":"/api-reference/crawl/cancel-crawl"}]},{"group":"SERP API","icon":"search","tag":"NEW","pages":[{"title":"SERP","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/serp","href":"/api-reference/serp/serp"},{"title":"SERP Async","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/serp/async","href":"/api-reference/serp/serp-async"},{"title":"SERP Batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/serp/batch","href":"/api-reference/serp/serp-batch"}]},{"group":"Media API","icon":"image","tag":"NEW","pages":[{"title":"Media Download","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/media","href":"/api-reference/media/media-download"},{"title":"Media Download Async","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/media/async","href":"/api-reference/media/media-download-async"}]},{"group":"Domain Health API","icon":"heart-pulse","tag":"NEW","pages":[{"title":"Check Domain Health","description":"Check whether Nimble is seeing healthy traffic to one or more domains right now, sourced from real request outcomes across Search, SERP, ecommerce, and Extract traffic.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domain-health/check","href":"/api-reference/domain-health/check-domain-health"}]},{"group":"Jobs API","icon":"timer","tag":"NEW","pages":[{"title":"Create Job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/jobs","href":"/api-reference/jobs/create-job"},{"title":"List Jobs","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs","href":"/api-reference/jobs/list-jobs"},{"title":"Get Job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/{job_id}","href":"/api-reference/jobs/get-job"},{"title":"Update Job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v2/jobs/{job_id}","href":"/api-reference/jobs/update-job"},{"title":"Delete Job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/jobs/{job_id}","href":"/api-reference/jobs/delete-job"},{"title":"Trigger Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/jobs/{job_id}/runs","href":"/api-reference/jobs/trigger-run"},{"title":"List Runs for Job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/{job_id}/runs","href":"/api-reference/jobs/list-runs-for-job"},{"title":"Get Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/runs/{run_id}","href":"/api-reference/jobs/get-run"},{"title":"Cancel Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/jobs/runs/{run_id}/cancel","href":"/api-reference/jobs/cancel-run"},{"title":"List Run Artifacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/runs/{run_id}/artifacts","href":"/api-reference/jobs/list-run-artifacts"},{"title":"Get Run Artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/runs/{run_id}/artifacts/{artifact_id}","href":"/api-reference/jobs/get-run-artifact"},{"title":"Preview Run Artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/runs/{run_id}/artifacts/{artifact_id}/preview","href":"/api-reference/jobs/preview-run-artifact"},{"title":"Get Run Artifact Download URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/runs/{run_id}/artifacts/{artifact_id}/download-url","href":"/api-reference/jobs/get-run-artifact-download-url"}]},{"group":"Tasks \u0026 Batches API","icon":"list-check","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Task Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/tasks/{task_id}","href":"/api-reference/tasks/task-status"},{"title":"Task Result","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/tasks/{task_id}/results","href":"/api-reference/tasks/task-result"},{"title":"List batches","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/batches","href":"/api-reference/tasks/list-batches"},{"title":"Get batch details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/batches/{batch_id}","href":"/api-reference/tasks/get-batch-details"},{"title":"Get batch progress","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/batches/{batch_id}/progress","href":"/api-reference/tasks/get-batch-progress"}]},{"group":"Usage API","icon":"chart-line","tag":"NEW","pages":[{"title":"Usage","icon":"chart-line","href":"/api-reference/usage"}]},{"group":"Proxy API","icon":"globe","pages":[]},{"group":"Fast SERP API","icon":"bolt","hidden":true,"tag":"NEW","pages":[{"title":"Fast Google SERP","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/realtime/serp","href":"/api-reference/fast-serp/fast-google-serp"}]}]},{"tab":"Changelog","icon":"bullhorn","pages":[{"title":"Changelog","href":"/changelog/release-notes"}]}]},"basePath":"","title":"Create Job - Nimble Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}