Rapidata Job API
The Job API from Rapidata — 21 operation(s) for job.
Rapidata Job API is one of 55 APIs that Rapidata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes 26 operations across 21 paths, and defines 66 schemas. It is described by OpenAPI 3.0.4, at version v1.
Requests are made against a single base URL, https://api.rapidata.ai/.
26 operations
21 paths
66 schemas
2 DELETE13 GET4 PATCH7 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Rapidata Job API declares
1 security scheme
for authenticating requests.
It supports OpenID Connect (OpenIdConnect) discovered at https://auth.rapidata.ai/.well-known/openid-configuration.
OpenIdConnect— OpenID Connect connection flow
Paths & Operations 26
Across 21 paths, the API surfaces 26 operations — 2 DELETE, 13 GET, 4 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.
Job 26
POST
/job/{jobId}/approve
Approves a job in manual review so its pipeline can start processing.
POST
/job/definition
Creates a new job definition.
POST
/job
Creates a new job from a job definition and audience.
POST
/job/definition/{definitionId}/revision
Creates a new revision for an existing job definition.
GET
/job/definition/{definitionId}/revision
Gets the latest revision for a job definition.
DELETE
/job/definition/{definitionId}
Deletes a job definition and all its revisions.
GET
/job/definition/{definitionId}
Gets a job definition by its id.
PATCH
/job/definition/{definitionId}
Updates a job definition.
DELETE
/job/{jobId}
Deletes a job.
GET
/job/{jobId}
Gets a job by its id.
PATCH
/job/{jobId}
Updates a job.
GET
/job/{jobId}/download-results
Downloads the results of a job as a file attachment.
GET
/job/{jobId}/cost-estimate
Estimates the cost of running a job to completion.
GET
/job/definition/{definitionId}/cost-estimate
Estimates the cost of running a job definition's latest revision to completion.
GET
/job/{jobId}/results
Gets the results of a job as a JSON string.
GET
/job/definition/{definitionId}/revision/{revisionNumber}
Gets a specific revision for a job definition.
POST
/job/{jobId}/pause
Pauses a job, stopping all of its campaigns from processing.
GET
/jobs/aggregated-overview
Retrieves jobs aggregated by customer with total counts and most recent job information.
GET
/job/definitions
Queries job definitions visible to the caller.
GET
/job/definition/{definitionId}/revisions
Queries the revisions of a specific job definition.
GET
/jobs
Queries jobs visible to the caller.
GET
/job/definitions/public
Queries job definitions that have been shared publicly, regardless of owner, so they can be reused as templates.
POST
/job/{jobId}/resume
Resumes a job, restarting all of its campaigns.
POST
/job/{jobId}/retry
Retries processing of a failed job.
PATCH
/job/definition/{definitionId}/share
Marks or unmarks a job definition as a public template that other users can discover and run.
PATCH
/job/{jobId}/share
Marks or unmarks a job as public so its results can be shared with other users.
Schemas 66
The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are GetJobByIdEndpoint_Output (17 properties), GetJobRevisionEndpoint_Output (14 properties), QueryJobsEndpoint_Output (10 properties), IOrderWorkflowInputModelGroupedRankingWorkflowInputModel (8 properties). Each schema is shown below with its type and property counts.
IOrderWorkflowInputModelGroupedRankingWorkflowInputModel
object
8 properties
2 required
CreateJobRevisionEndpoint_Input
object
The input for the create job revision endpoint.
7 properties
FeatureFlag
object
2 properties
2 required
IRapidBlueprint
object
1 required
MetadataVisibilities
array
IRapidBlueprintAttachCategoryRapidBlueprint
object
4 properties
3 required
IRankingConfigModel
object
1 required
IAssetInputMultiAssetInput
object
4 properties
2 required
IRankingConfigModelBradleyTerryRankingConfigModel
object
2 properties
2 required
QueryJobRevisionsEndpoint_PagedResultOfOutput
object
5 properties
4 required
UpdateJobDefinitionEndpoint_Input
object
The input for the update job definition endpoint.
1 property
AttachCategoryRapidBlueprint_Category
object
2 properties
2 required
AggregatorType
IRefereeModelQuorumRefereeModel
object
3 properties
3 required
IPairMakerConfigModelFullPermutationPairMakerConfigModel
object
1 property
1 required
QueryJobDefinitionsEndpoint_Output
object
7 properties
7 required
JobDefinitionRevisionState
IAssetInputTextAssetInput
object
4 properties
2 required
IRapidBlueprintPolygonRapidBlueprint
object
2 properties
2 required
ValidationProblemDetails
object
6 properties
QueryJobDefinitionsEndpoint_PagedResultOfOutput
object
5 properties
4 required
QueryPublicJobDefinitionsEndpoint_Output
object
7 properties
7 required
IPairMakerConfigModelOnlinePairMakerConfigModel
object
3 properties
1 required
IOrderWorkflowInputModelSimpleWorkflowInputModel
object
4 properties
2 required
CreateJobEndpoint_CostWarningModel
object
3 properties
3 required
IRapidBlueprintFreeTextRapidBlueprint
object
4 properties
2 required
IRapidBlueprintBoundingBoxRapidBlueprint
object
2 properties
2 required
GetJobRevisionEndpoint_Output
object
The result when a job revision has been retrieved.
14 properties
11 required
UpdateJobEndpoint_Input
object
The input for the update job endpoint.
1 property
IRapidBlueprintNamedEntityRapidBlueprint
object
3 properties
3 required
IMetadataInputTextMetadataInput
object
3 properties
3 required
GetJobByIdEndpoint_Output
object
The result when a job has been retrieved.
17 properties
12 required
IAssetInput
object
1 required
CreateJobEndpoint_Input
object
The input for the create job endpoint.
7 properties
2 required
IRapidBlueprintCompareRapidBlueprint
object
3 properties
2 required
IRefereeModelNaiveRefereeModel
object
2 properties
2 required
QueryJobsEndpoint_PagedResultOfOutput
object
5 properties
4 required
QueryPublicJobDefinitionsEndpoint_PagedResultOfOutput
object
5 properties
4 required
QueryJobRevisionsEndpoint_Output
object
4 properties
4 required
QueryAggregatedJobsEndpoint_PagedResultOfOutput
object
5 properties
4 required
CreateJobEndpoint_Output
object
The result when a job has been created.
3 properties
2 required
IRapidBlueprintLocateRapidBlueprint
object
2 properties
2 required
GetJobDefinitionCostEstimateEndpoint_Output
object
The estimated cost of a job definition.
4 properties
4 required
IRefereeModelBudgetRefereeModel
object
2 properties
2 required
DefinitionType
QueryJobsEndpoint_Output
object
10 properties
9 required
IRankingConfigModelEloConfigModel
object
4 properties
4 required
MetadataInputCollection
object
IRefereeModelEarlyStoppingRefereeModel
object
3 properties
3 required
AudienceJobState
CreateJobRevisionEndpoint_Output
object
The result when a job revision has been created.
2 properties
2 required
IPairMakerConfigModel
object
1 required
IRapidBlueprintScrubRapidBlueprint
object
2 properties
2 required
GetJobDefinitionByIdEndpoint_Output
object
The result when a job definition has been retrieved.
7 properties
7 required
CreateJobDefinitionEndpoint_Input
object
The input for the create job definition endpoint.
7 properties
4 required
IOrderWorkflowInputModelEvaluationWorkflowInputModel
object
4 properties
3 required
IMetadataInput
object
1 required
IOrderWorkflowInputModel
object
1 required
IAssetInputExistingAssetInput
object
4 properties
2 required
CreateJobDefinitionEndpoint_Output
object
The result when a job definition has been created.
2 properties
2 required
QueryAggregatedJobsEndpoint_Output
object
6 properties
6 required
IRapidBlueprintTranscriptionRapidBlueprint
object
2 properties
2 required
IRefereeModel
object
1 required
GetJobCostEstimateEndpoint_Output
object
The estimated cost of a job.
4 properties
4 required
IRapidBlueprintLineRapidBlueprint
object
2 properties
2 required
ReviewReasonModel
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Rapidata 12
Other APIs Rapidata publishes across the network.
Rapidata Asset API
Rapidata Audience API
Rapidata BatchUpload API
Rapidata Benchmark API
Rapidata Billing API
Rapidata BillingAccount API
Rapidata Cache API
Rapidata Campaign API
Rapidata Client API
Rapidata ContextShortening API
Rapidata Customer API
Rapidata CustomerRapid API
#Job