Nuance Jobs API
The Jobs API from Nuance — 2 operation(s) for jobs.
The Jobs API from Nuance — 2 operation(s) for jobs.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/nuance:nuance-jobs-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Mix.api Specification Jobs API
version: 26.1026.216
security:
- OAuth2:
- mix-api
bearerAuth: []
tags:
- name: Jobs
paths:
/v4/projects/{projectId}/jobs/{jobId}:
get:
summary: Get job details
description: Retrieve the details of a job in a project.
operationId: MixAPI_GetJob
responses:
'200':
description: Job details
content:
application/json:
schema:
type: array
$ref: '#/components/schemas/mix.api.JobResponse'
'401':
description: Request could not be authorized
content:
application/json:
schema: {}
'404':
description: Job not found
content:
application/json:
schema: {}
'500':
description: Internal server error
content:
application/json:
schema: {}
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
parameters:
- name: projectId
description: ID of the project.
in: path
required: true
schema:
type: string
- name: jobId
description: ID of the job.
in: path
required: true
schema:
type: string
tags:
- Jobs
delete:
summary: Delete a job
description: Delete the specified job.
operationId: MixAPI_DeleteJob
responses:
'200':
description: Job successfully deleted
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
'401':
description: Request could not be authorized
content:
application/json:
schema: {}
'404':
description: Job not found
content:
application/json:
schema: {}
'500':
description: Internal server error
content:
application/json:
schema: {}
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
parameters:
- name: projectId
description: ID of the project.
in: path
required: true
schema:
type: string
- name: jobId
description: ID of the job.
in: path
required: true
schema:
type: string
tags:
- Jobs
/v4/projects/{projectId}/jobs:
get:
summary: Get jobs
description: Retrieve the list of jobs available in a project.
operationId: MixAPI_ListProjectJobs
responses:
'200':
description: List of jobs
content:
application/json:
schema:
type: array
$ref: '#/components/schemas/mix.api.ListProjectJobsResponse'
'401':
description: Request could not be authorized
content:
application/json:
schema: {}
'404':
description: Project not found
content:
application/json:
schema: {}
'500':
description: Internal server error
content:
application/json:
schema: {}
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
parameters:
- name: projectId
description: ID of the project.
in: path
required: true
schema:
type: string
- name: limit
description: Maximum number of job results to return.
in: query
required: false
schema:
type: integer
format: int32
- name: offset
description: Offset to use when returning results.
in: query
required: false
schema:
type: integer
format: int32
- name: sortBy
description: 'Sort parameter; use the format: +id.'
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
tags:
- Jobs
components:
schemas:
mix.api.JobReport:
type: object
properties:
nluBuildReports:
$ref: '#/components/schemas/mix.api.GenericBuildReports'
description: NLU job reports, if applicable.
asrBuildReports:
$ref: '#/components/schemas/mix.api.GenericBuildReports'
description: ASR job reports, if applicable.
dialogBuildReports:
$ref: '#/components/schemas/mix.api.GenericBuildReports'
description: Dialog job reports, if applicable.
replaceProjectDialogReports:
$ref: '#/components/schemas/mix.api.GenericProjectReports'
description: Replace project dialog job reports, if applicable.
replaceProjectContentReports:
$ref: '#/components/schemas/mix.api.GenericProjectReports'
description: Replace project content job reports, if applicable.
replaceProjectPronunciationsReports:
$ref: '#/components/schemas/mix.api.GenericProjectReports'
description: Replace project pronunciations job reports, if applicable.
replaceProjectTransformationsReports:
$ref: '#/components/schemas/mix.api.GenericProjectReports'
description: Replace project transformations job reports, if applicable.
resetProjectReports:
$ref: '#/components/schemas/mix.api.GenericProjectReports'
description: Reset project job reports, if applicable.
appendProjectOntologyReports:
$ref: '#/components/schemas/mix.api.GenericProjectReports'
description: Append project ontology job reports, if applicable.
addProjectIntentSamplesReports:
$ref: '#/components/schemas/mix.api.GenericProjectReports'
description: Add project intent samples job reports, if applicable.
removeProjectIntentSamplesReports:
$ref: '#/components/schemas/mix.api.GenericProjectReports'
description: Remove project intent samples job reports, if applicable.
addEntityLiteralsReports:
$ref: '#/components/schemas/mix.api.GenericProjectReports'
description: Add entity literals job reports, if applicable.
removeEntityLiteralsReports:
$ref: '#/components/schemas/mix.api.GenericProjectReports'
description: Remove entity literals task reports, if applicable.
replaceProjectMetadataReports:
$ref: '#/components/schemas/mix.api.GenericProjectReports'
description: Replace project metadata reports, if applicable.(Limited to project channels).
updateDatapackReports:
$ref: '#/components/schemas/mix.api.GenericProjectReports'
description: Update NLU data pack reports, if applicable.
applicationDeploymentReports:
$ref: '#/components/schemas/mix.api.GenericApplicationReports'
description: Message that defines a job report.
mix.api.GenericProjectReport:
type: object
properties:
locale:
type: string
description: Project locale, if applicable.
errors:
$ref: '#/components/schemas/mix.api.Errors'
description: Job errors, if applicable.
status:
$ref: '#/components/schemas/mix.api.JobStatusType'
description: Status of the job.
intent:
type: string
description: Target intent, if applicable.
entity:
type: string
description: Target entity, if applicable.
createTime:
type: string
format: date-time
description: Date and time the report was created.
description: Message that defines a project report.
google.protobuf.Any:
type: object
properties:
type_url:
type: string
description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
value:
type: string
format: byte
description: Must be a valid serialized protocol buffer of the above specified type.
description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := &pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": <string>,\n \"lastName\": <string>\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }"
mix.api.JobType:
type: string
enum:
- BUILD_MODELS
- REPLACE_PROJECT
- APPEND_ONTOLOGY
- APPEND_INTENT_SAMPLES
- REPLACE_INTENT_SAMPLES
- APPEND_ENTITY_LITERALS
- REPLACE_ENTITY_LITERALS
- UPDATE_DATAPACK
- DEPLOY_BOT
default: BUILD_MODELS
description: "ENUM that defines the type of job.\n\n - BUILD_MODELS: Build ASR, NLU, and dialog models\n - REPLACE_PROJECT: Replace project\n - APPEND_ONTOLOGY: Append ontology\n - APPEND_INTENT_SAMPLES: Append samples to intent\n - REPLACE_INTENT_SAMPLES: Replace intent samples\n - APPEND_ENTITY_LITERALS: Append entity literals\n - REPLACE_ENTITY_LITERALS: Replace entity literals\n - UPDATE_DATAPACK: Update data pack\n - DEPLOY_BOT: Deploy bot"
mix.api.GenericBuildReport:
type: object
properties:
locale:
type: string
description: Locale used for the build, if applicable.
version:
type: string
description: Build model version, if applicable.
errors:
$ref: '#/components/schemas/mix.api.Errors'
description: Job errors, if applicable.
buildLabel:
type: string
description: Build label, if applicable.
createTime:
type: string
format: date-time
description: Date and time the report was created.
status:
type: string
description: Status of the task.
description: Message that defines a build report.
mix.api.GenericApplicationReports:
type: object
properties:
reports:
type: array
items:
$ref: '#/components/schemas/mix.api.GenericApplicationReport'
description: List of application reports.
description: Message that defines a list of application related reports.
mix.api.GenericBuildReports:
type: object
properties:
reports:
type: array
items:
$ref: '#/components/schemas/mix.api.GenericBuildReport'
description: List of build reports.
description: Message that defines a list of build reports.
mix.api.Error:
type: object
properties:
message:
type: string
description: Error message, if applicable.
code:
type: string
description: Error code, if applicable.
description: Message that defines an error.
mix.api.ListProjectJobsResponse:
type: object
example:
jobs:
- id: 430a4626-3b41-4fa2-bb8b-db1c7c2c7189
type: APPEND_INTENT_SAMPLES
projectId: '2960'
status: COMPLETED
createTime: '2021-06-08T21:10:37.456Z'
updateTime: '2021-06-08T21:10:52.052Z'
duration: 14.596s
totalSize: 1
count: 1
limit: 10
offset: 0
properties:
jobs:
type: array
items:
$ref: '#/components/schemas/mix.api.JobResponse'
description: List of jobs for the project specified.
totalSize:
type: integer
format: int32
description: Total number of jobs that match the request.
count:
type: integer
format: int32
description: Number of results returned.
limit:
type: integer
format: int32
description: Value of limit field specified in request.
offset:
type: integer
format: int32
description: Value of offset field specified in request.
description: Response object returned by the Get jobs request.
grpc.gateway.runtime.Error:
type: object
properties:
error:
type: string
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
$ref: '#/components/schemas/google.protobuf.Any'
google.rpc.Status:
type: object
properties:
code:
type: integer
format: int32
description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
message:
type: string
description: 'A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
[google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.'
details:
type: array
items:
$ref: '#/components/schemas/google.protobuf.Any'
description: 'A list of messages that carry the error details. There will be a
common set of message types for APIs to use.'
description: "- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\n[google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons."
title: 'The `Status` type defines a logical error model that is suitable for different
programming environments, including REST APIs and RPC APIs. It is used by
[gRPC](https://github.com/grpc). The error model is designed to be:'
mix.api.JobStatusType:
type: string
enum:
- RUNNING
- COMPLETED
- PARTIALLY_COMPLETED
- FAILED
- CANCELED
- TIMED_OUT
- STARTED
default: RUNNING
description: "ENUM that defines the status of a job.\n\n - RUNNING: Job is currently running\n - COMPLETED: Job has completed\n - PARTIALLY_COMPLETED: Job has partially completed; for example, a build operation failed\n - FAILED: Job has failed\n - CANCELED: Job was cancelled\n - TIMED_OUT: Job has timed out; this occurs when a job fails to complete in 6 hours\n - STARTED: Job has started"
mix.api.GenericProjectReports:
type: object
properties:
reports:
type: array
items:
$ref: '#/components/schemas/mix.api.GenericProjectReport'
description: List of project reports.
description: Message that defines a list of project related reports.
mix.api.Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/mix.api.Error'
description: List of build errors, if applicable.
description: Message that defines errors.
mix.api.GenericApplicationReport:
type: object
properties:
status:
$ref: '#/components/schemas/mix.api.JobStatusType'
description: Status of the job.
applicationId:
type: string
applicationConfigId:
type: string
powerPlatformBotId:
type: string
errors:
$ref: '#/components/schemas/mix.api.Errors'
createTime:
type: string
format: date-time
description: Message that defines a application report.
mix.api.JobResponse:
type: object
example:
id: 430a4626-3b41-4fa2-bb8b-db1c7c2c7189
type: APPEND_INTENT_SAMPLES
projectId: '2960'
status: COMPLETED
report:
addProjectIntentSamplesReports:
reports:
- status: COMPLETED
locale: en-US
createTime: '2021-06-08T21:10:38.076Z'
createTime: '2021-06-08T21:10:37.456Z'
updateTime: '2021-06-08T21:10:52.052Z'
duration: 14.596s
properties:
id:
type: string
description: ID of the job.
type:
$ref: '#/components/schemas/mix.api.JobType'
description: Type of the job.
projectId:
type: string
description: ID of the project for which the job was created.
status:
$ref: '#/components/schemas/mix.api.JobStatusType'
description: Status of the job.
report:
$ref: '#/components/schemas/mix.api.JobReport'
description: Job report, if applicable.
createTime:
type: string
format: date-time
description: Date and time the job was created.
updateTime:
type: string
format: date-time
description: Date and time the job was last updated.
duration:
type: string
description: Duration for the current job state.
description: Response object returned by the Get job details request.
securitySchemes:
OAuth2:
type: oauth2
flows:
clientCredentials:
scopes:
mix-api: Grants access to mix-api
tokenUrl: /oauth2/token
bearerAuth:
type: apiKey
name: Authorization
in: header