# Create Job

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Job"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/api/v2/workspaces/{workspace_id}/jobs"}
  context={"endpoint"}
>
  
</MethodEndpoint>

Create a batch job against a pipeline, either referencing an existing query set via 'query_set_id' or providing 'queries' inline (an inline query set is created for you). The job is not run until 'POST .../jobs/\{job_id\}/start' is called.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"description":"Type the id of the workspace.","in":"path","name":"workspace_id","required":true,"schema":{"description":"Type the id of the workspace.","format":"uuid","title":"Workspace Id","type":"string"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"properties":{"concurrency":{"default":1,"maximum":100,"minimum":1,"title":"Concurrency","type":"integer"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"execution_mode":{"default":"ACROSS_FILES","enum":["ACROSS_FILES","PER_FILE"],"title":"ExecutionMode","type":"string"},"name":{"title":"Name","type":"string"},"pipeline_id":{"format":"uuid","title":"Pipeline Id","type":"string"},"queries":{"anyOf":[{"items":{"properties":{"filters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Filters"},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name"},"params":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Params"},"query":{"title":"Query","type":"string"},"query_index":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Query Index"},"query_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query Label"}},"required":["query"],"title":"QueryRow","type":"object"},"type":"array"},{"type":"null"}],"title":"Queries"},"query_set_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"title":"Query Set Id"}},"required":["name","pipeline_id"],"title":"CreateJob","type":"object"}}},"required":true}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"content":{"application/json":{"schema":{"properties":{"concurrency":{"title":"Concurrency","type":"integer"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"created_by":{"anyOf":[{"properties":{"family_name":{"description":"Family name of a user.","title":"Family name","type":"string"},"given_name":{"description":"Given name of a user.","title":"Given name","type":"string"},"user_id":{"description":"Unique identifier of a user.","format":"uuid","title":"User ID","type":"string"}},"required":["given_name","family_name","user_id"],"title":"Oauth User","type":"object"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"duration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration"},"executed_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Executed At"},"executed_requests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Executed Requests"},"execution_mode":{"enum":["ACROSS_FILES","PER_FILE"],"title":"ExecutionMode","type":"string"},"job_id":{"format":"uuid","title":"Job Id","type":"string"},"last_edited_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Last Edited At"},"last_edited_by":{"anyOf":[{"properties":{"family_name":{"description":"Family name of a user.","title":"Family name","type":"string"},"given_name":{"description":"Given name of a user.","title":"Given name","type":"string"},"user_id":{"description":"Unique identifier of a user.","format":"uuid","title":"User ID","type":"string"}},"required":["given_name","family_name","user_id"],"title":"Oauth User","type":"object"},{"type":"null"}]},"name":{"title":"Name","type":"string"},"pipeline_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"title":"Pipeline Id"},"pipeline_name":{"title":"Pipeline Name","type":"string"},"query_set_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"title":"Query Set Id"},"status":{"enum":["CREATED","STARTED","FAILED","ENDED"],"title":"JobStatus","type":"string"},"total_requests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Requests"}},"required":["job_id","name","description","pipeline_name","query_set_id","execution_mode","concurrency","status","total_requests","executed_requests","created_by","created_at","last_edited_at","executed_at","duration"],"title":"JobResponse","type":"object"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"ctx":{"title":"Context","type":"object"},"input":{"title":"Input"},"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"}}},"description":"Validation Error"}}}
>
  
</StatusCodes>