How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, 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.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.rapidata.ai/
Authentication
OpenID Connect
Resource Areas
1

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
postJobByJobIdApprove 1 param → 204400401403
POST
/job/definition
Creates a new job definition
postJobDefinition body → 200400401403
POST
/job
Creates a new job from a job definition and audience
postJob body → 200400401403
POST
/job/definition/{definitionId}/revision
Creates a new revision for an existing job definition
postJobDefinitionByDefinitionIdRevision 1 param body → 200400401403
GET
/job/definition/{definitionId}/revision
Gets the latest revision for a job definition
getJobDefinitionByDefinitionIdRevision 1 param → 200400401403
DELETE
/job/definition/{definitionId}
Deletes a job definition and all its revisions
deleteJobDefinitionByDefinitionId 1 param → 204400401403
GET
/job/definition/{definitionId}
Gets a job definition by its id
getJobDefinitionByDefinitionId 1 param → 200400401403
PATCH
/job/definition/{definitionId}
Updates a job definition
patchJobDefinitionByDefinitionId 1 param body → 204400401403
DELETE
/job/{jobId}
Deletes a job
deleteJobByJobId 1 param → 204400401403
GET
/job/{jobId}
Gets a job by its id
getJobByJobId 1 param → 200400401403
PATCH
/job/{jobId}
Updates a job
patchJobByJobId 1 param body → 204400401403
GET
/job/{jobId}/download-results
Downloads the results of a job as a file attachment
getJobByJobIdDownloadResults 1 param → 200401403
GET
/job/{jobId}/cost-estimate
Estimates the cost of running a job to completion
getJobByJobIdCostEstimate 1 param → 200400401403
GET
/job/definition/{definitionId}/cost-estimate
Estimates the cost of running a job definition's latest revision to completion
getJobDefinitionByDefinitionIdCostEstimate 1 param → 200400401403
GET
/job/{jobId}/results
Gets the results of a job as a JSON string
getJobByJobIdResults 1 param → 200401403
GET
/job/definition/{definitionId}/revision/{revisionNumber}
Gets a specific revision for a job definition
getJobDefinitionByDefinitionIdRevisionByRevisionNumber 2 params → 200400401403
POST
/job/{jobId}/pause
Pauses a job, stopping all of its campaigns from processing
postJobByJobIdPause 1 param → 204400401403
GET
/jobs/aggregated-overview
Retrieves jobs aggregated by customer with total counts and most recent job…
getJobsAggregatedOverview 7 params → 200400401403
GET
/job/definitions
Queries job definitions visible to the caller
getJobDefinitions 10 params → 200400401403
GET
/job/definition/{definitionId}/revisions
Queries the revisions of a specific job definition
getJobDefinitionByDefinitionIdRevisions 8 params → 200400401403
GET
/jobs
Queries jobs visible to the caller
getJobs 11 params → 200400401403
GET
/job/definitions/public
Queries job definitions that have been shared publicly, regardless of owner, so…
getJobDefinitionsPublic 10 params → 200400401403
POST
/job/{jobId}/resume
Resumes a job, restarting all of its campaigns
postJobByJobIdResume 1 param → 204400401403
POST
/job/{jobId}/retry
Retries processing of a failed job
postJobByJobIdRetry 1 param → 204400401403
PATCH
/job/definition/{definitionId}/share
Marks or unmarks a job definition as a public template that other users can…
patchJobDefinitionByDefinitionIdShare 2 params → 204400401403
PATCH
/job/{jobId}/share
Marks or unmarks a job as public so its results can be shared with other users
patchJobByJobIdShare 2 params → 204400401403

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.

IAssetInput
object
1 required
MetadataVisibilities
array
QueryJobDefinitionsEndpoint_Output
object
7 properties 7 required
IRefereeModelBudgetRefereeModel
object
2 properties 2 required
CreateJobDefinitionEndpoint_Output
object
The result when a job definition has been created.
2 properties 2 required
IRapidBlueprintLocateRapidBlueprint
object
2 properties 2 required
AttachCategoryRapidBlueprint_Category
object
2 properties 2 required
IAssetInputMultiAssetInput
object
4 properties 2 required
UpdateJobDefinitionEndpoint_Input
object
The input for the update job definition endpoint.
1 property
CreateJobDefinitionEndpoint_Input
object
The input for the create job definition endpoint.
7 properties 4 required
IOrderWorkflowInputModelSimpleWorkflowInputModel
object
4 properties 2 required
IRefereeModelNaiveRefereeModel
object
2 properties 2 required
IAssetInputTextAssetInput
object
4 properties 2 required
IAssetInputExistingAssetInput
object
4 properties 2 required
IRefereeModel
object
1 required
AggregatorType
IRapidBlueprintFreeTextRapidBlueprint
object
4 properties 2 required
QueryJobsEndpoint_PagedResultOfOutput
object
5 properties 4 required
IRapidBlueprintCompareRapidBlueprint
object
3 properties 2 required
GetJobCostEstimateEndpoint_Output
object
The estimated cost of a job.
4 properties 4 required
IRankingConfigModelBradleyTerryRankingConfigModel
object
2 properties 2 required
GetJobDefinitionByIdEndpoint_Output
object
The result when a job definition has been retrieved.
7 properties 7 required
FeatureFlag
object
2 properties 2 required
QueryJobsEndpoint_Output
object
10 properties 9 required
IMetadataInputTextMetadataInput
object
3 properties 3 required
MetadataInputCollection
object
IPairMakerConfigModel
object
1 required
IRapidBlueprintTranscriptionRapidBlueprint
object
2 properties 2 required
CreateJobRevisionEndpoint_Output
object
The result when a job revision has been created.
2 properties 2 required
IRapidBlueprintBoundingBoxRapidBlueprint
object
2 properties 2 required
GetJobDefinitionCostEstimateEndpoint_Output
object
The estimated cost of a job definition.
4 properties 4 required
CreateJobEndpoint_Input
object
The input for the create job endpoint.
7 properties 2 required
QueryPublicJobDefinitionsEndpoint_PagedResultOfOutput
object
5 properties 4 required
IRapidBlueprintScrubRapidBlueprint
object
2 properties 2 required
IRankingConfigModelEloConfigModel
object
4 properties 4 required
QueryJobRevisionsEndpoint_PagedResultOfOutput
object
5 properties 4 required
JobDefinitionRevisionState
QueryAggregatedJobsEndpoint_PagedResultOfOutput
object
5 properties 4 required
QueryAggregatedJobsEndpoint_Output
object
6 properties 6 required
QueryJobDefinitionsEndpoint_PagedResultOfOutput
object
5 properties 4 required
UpdateJobEndpoint_Input
object
The input for the update job endpoint.
1 property
GetJobRevisionEndpoint_Output
object
The result when a job revision has been retrieved.
14 properties 11 required
IRapidBlueprintLineRapidBlueprint
object
2 properties 2 required
CreateJobEndpoint_CostWarningModel
object
3 properties 3 required
IRapidBlueprint
object
1 required
IMetadataInput
object
1 required
CreateJobEndpoint_Output
object
The result when a job has been created.
3 properties 2 required
QueryJobRevisionsEndpoint_Output
object
4 properties 4 required
IRapidBlueprintAttachCategoryRapidBlueprint
object
4 properties 3 required
IRapidBlueprintNamedEntityRapidBlueprint
object
3 properties 3 required
IRefereeModelQuorumRefereeModel
object
3 properties 3 required
ReviewReasonModel
IPairMakerConfigModelFullPermutationPairMakerConfigModel
object
1 property 1 required
GetJobByIdEndpoint_Output
object
The result when a job has been retrieved.
17 properties 12 required
IRefereeModelEarlyStoppingRefereeModel
object
3 properties 3 required
DefinitionType
IRapidBlueprintPolygonRapidBlueprint
object
2 properties 2 required
IRankingConfigModel
object
1 required
IPairMakerConfigModelOnlinePairMakerConfigModel
object
3 properties 1 required
CreateJobRevisionEndpoint_Input
object
The input for the create job revision endpoint.
7 properties
IOrderWorkflowInputModelEvaluationWorkflowInputModel
object
4 properties 3 required
AudienceJobState
ValidationProblemDetails
object
6 properties
IOrderWorkflowInputModelGroupedRankingWorkflowInputModel
object
8 properties 2 required
IOrderWorkflowInputModel
object
1 required
QueryPublicJobDefinitionsEndpoint_Output
object
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapidata-job-api-openapi.yml Raw ↑

Other APIs Rapidata publishes across the network.

Rapidata Asset API
Rapidata Audience API
Rapidata Benchmark API
Rapidata Billing API
Rapidata Cache API
Rapidata Campaign API
Rapidata Client API
Rapidata ContextShortening API
Rapidata Customer API
Rapidata CustomerRapid API
Rapidata Datapoints API
Rapidata Dataset API
Where this information came from

This is an independent, third-party profile of Rapidata Job API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.