---
swagger: "2.0"
info:
  description: "Flowable Platform"
  version: "v1"
  title: "Flowable Agent Engine REST API"
  contact:
    name: "Flowable"
    url: "http://www.flowable.com/"
host: "localhost:8090"
basePath: "/agent-api"
tags:
- name: "Agent Connections"
- name: "Agent Definitions"
- name: "Agent Deployments"
- name: "Agent Instances"
- name: "Agent Invocation"
- name: "Agent Invocation Evaluations"
- name: "Agent Invocation Exchanges"
- name: "Agent Invocations"
- name: "Agent Model Pricing"
- name: "Historic Agent Instances"
- name: "Historic agent knowledge base links"
- name: "Jobs"
- name: "Knowledge Base  Items"
- name: "Knowledge Base Definitions"
- name: "Knowledge Base Items"
schemes:
- "http"
- "https"
paths:
  /agent-history/agent-invocation-evaluations:
    get:
      tags:
      - "Agent Invocation Evaluations"
      summary: "Query agent invocation evaluations"
      description: ""
      operationId: "queryAgentInvocationEvaluations"
      produces:
      - "application/json"
      parameters:
      - name: "agentInstanceId"
        in: "query"
        description: "Filter evaluations based on their agent instance id"
        required: false
        type: "string"
      - name: "evaluatorKey"
        in: "query"
        description: "Filter evaluations based on their evaluator key"
        required: false
        type: "string"
      - name: "invocationId"
        in: "query"
        description: "Filter evaluations based on their agent invocation id"
        required: false
        type: "string"
      - name: "kind"
        in: "query"
        description: "Filter evaluations based on their kind (agent, service, delegateExpression)"
        required: false
        type: "string"
      - name: "order"
        in: "query"
        description: "From the paginate request.  The sort order, either 'asc' or\
          \ 'desc'. Defaults to 'asc'."
        required: false
        type: "string"
      - name: "passed"
        in: "query"
        description: "Filter evaluations based on their verdict"
        required: false
        type: "boolean"
      - name: "size"
        in: "query"
        description: "From the paginate request. Number of rows to fetch, starting\
          \ from start. Defaults to 10."
        required: false
        type: "integer"
        format: "int32"
      - name: "sort"
        in: "query"
        description: "Property to sort the results on"
        required: false
        type: "string"
      - name: "start"
        in: "query"
        description: "From the paginate request. Index of the first row to fetch.\
          \ Defaults to 0."
        required: false
        type: "integer"
        format: "int32"
      - name: "tenantId"
        in: "query"
        description: "Filter evaluations based on the tenant id"
        required: false
        type: "string"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/DataResponseAgentInvocationEvaluationResponse"
        400:
          description: "Indicates the request had some invalid arguments."
        403:
          description: "Indicates that the user does not have access to query agent\
            \ invocation evaluations"
      security:
      - basicAuth: []
  /agent-history/agent-invocation-exchanges:
    get:
      tags:
      - "Agent Invocation Exchanges"
      summary: "Query agent invocation exchanges"
      description: ""
      operationId: "queryAgentInvocationExchanges"
      produces:
      - "application/json"
      parameters:
      - name: "agentDefinitionId"
        in: "query"
        description: "Filter exchanges based on their agent definition id"
        required: false
        type: "string"
      - name: "agentDefinitionKey"
        in: "query"
        description: "Filter exchanges based on their agent definition key"
        required: false
        type: "string"
      - name: "agentInstanceId"
        in: "query"
        description: "Filter exchanges based on their agent instance id"
        required: false
        type: "string"
      - name: "agentInvocationId"
        in: "query"
        description: "Filter exchanges based on their agent invocation id"
        required: false
        type: "string"
      - name: "operationKey"
        in: "query"
        description: "Filter exchanges based on their operation key"
        required: false
        type: "string"
      - name: "order"
        in: "query"
        description: "From the paginate request.  The sort order, either 'asc' or\
          \ 'desc'. Defaults to 'asc'."
        required: false
        type: "string"
      - name: "size"
        in: "query"
        description: "From the paginate request. Number of rows to fetch, starting\
          \ from start. Defaults to 10."
        required: false
        type: "integer"
        format: "int32"
      - name: "sort"
        in: "query"
        description: "Property to sort the results on"
        required: false
        type: "string"
      - name: "start"
        in: "query"
        description: "From the paginate request. Index of the first row to fetch.\
          \ Defaults to 0."
        required: false
        type: "integer"
        format: "int32"
      - name: "subType"
        in: "query"
        description: "Filter exchanges based on their sub type"
        required: false
        type: "string"
      - name: "subTypeLike"
        in: "query"
        description: "Filter exchanges with a sub type like the requested."
        required: false
        type: "string"
      - name: "tenantId"
        in: "query"
        description: "Filter exchanges based on the tenant id"
        required: false
        type: "string"
      - name: "type"
        in: "query"
        description: "Filter exchanges based on their type"
        required: false
        type: "string"
      - name: "userId"
        in: "query"
        description: "Filter exchanges based on the user that created them"
        required: false
        type: "string"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/DataResponseAgentInvocationExchangeResponse"
        400:
          description: "Indicates the request had some invalid arguments."
        403:
          description: "Indicates that the user does not have access to query agent\
            \ invocation exchanges"
      security:
      - basicAuth: []
  /agent-history/agent-invocation-exchanges/{exchangeId}:
    get:
      tags:
      - "Agent Invocation Exchanges"
      summary: "Get agent invocation exchange"
      description: ""
      operationId: "getAgentInvocationExchange"
      produces:
      - "application/json"
      parameters:
      - name: "exchangeId"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/AgentInvocationExchangeResponse"
        400:
          description: "Indicates the request had some invalid arguments."
        403:
          description: "Indicates that the user does not have access to get an agent\
            \ invocation exchange"
        404:
          description: "Indicates that agent invocation exchange does not exist or\
            \ the user does not have access to it."
      security:
      - basicAuth: []
  /agent-history/agent-invocation-exchanges/{exchangeId}/parts:
    get:
      tags:
      - "Agent Invocation Exchanges"
      summary: "Get agent invocation exchange parts"
      description: ""
      operationId: "getAgentInvocationExchangeParts"
      produces:
      - "application/json"
      parameters:
      - name: "exchangeId"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            type: "array"
            items:
              $ref: "#/definitions/AgentInvocationExchangePartResponse"
        400:
          description: "Indicates the request had some invalid arguments."
        403:
          description: "Indicates that the user does not have access to get an agent\
            \ invocation exchange"
        404:
          description: "Indicates that agent invocation exchange does not exist or\
            \ the user does not have access to it."
      security:
      - basicAuth: []
  /agent-history/agent-invocations:
    get:
      tags:
      - "Agent Invocations"
      summary: "Query agent invocations"
      description: ""
      operationId: "queryAgentInvocations"
      produces:
      - "application/json"
      parameters:
      - name: "agentInstanceId"
        in: "query"
        description: "Filter invocations based on their agent instance id"
        required: false
        type: "string"
      - name: "finished"
        in: "query"
        description: "Filter invocations based on whether they are finished or not"
        required: false
        type: "boolean"
      - name: "id"
        in: "query"
        description: "Filter invocations based on their id"
        required: false
        type: "string"
      - name: "operationKey"
        in: "query"
        description: "Filter invocations based on their operation key"
        required: false
        type: "string"
      - name: "order"
        in: "query"
        description: "From the paginate request.  The sort order, either 'asc' or\
          \ 'desc'. Defaults to 'asc'."
        required: false
        type: "string"
      - name: "size"
        in: "query"
        description: "From the paginate request. Number of rows to fetch, starting\
          \ from start. Defaults to 10."
        required: false
        type: "integer"
        format: "int32"
      - name: "sort"
        in: "query"
        description: "Property to sort the results on"
        required: false
        type: "string"
      - name: "start"
        in: "query"
        description: "From the paginate request. Index of the first row to fetch.\
          \ Defaults to 0."
        required: false
        type: "integer"
        format: "int32"
      - name: "tenantId"
        in: "query"
        description: "Filter invocations based on the tenant id"
        required: false
        type: "string"
      - name: "userId"
        in: "query"
        description: "Filter invocations based on the user that created them"
        required: false
        type: "string"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/DataResponseAgentInvocationResponse"
        400:
          description: "Indicates the request had some invalid arguments."
        403:
          description: "Indicates that the user does not have access to the query\
            \ agent invocations."
      security:
      - basicAuth: []
  /agent-history/agent-invocations/{invocationId}:
    get:
      tags:
      - "Agent Invocations"
      summary: "Get agent invocation"
      description: ""
      operationId: "getAgentInvocation"
      produces:
      - "application/json"
      parameters:
      - name: "invocationId"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/AgentInvocationResponse"
        400:
          description: "Indicates the request had some invalid arguments."
        403:
          description: "Indicates that the user does not have access to get an agent\
            \ invocation"
        404:
          description: "Indicates that agent invocation does not exist or the user\
            \ does not have access to it."
      security:
      - basicAuth: []
  /agent-history/historic-agent-instance-knowledge-base-links:
    get:
      tags:
      - "Historic Agent Instances"
      summary: "Get historic agent instance knowledge base links"
      description: ""
      operationId: "getHistoricAgentInstanceKnowledgeBaseLinks"
      produces:
      - "application/json"
      parameters:
      - name: "order"
        in: "query"
        description: "From the paginate request.  The sort order, either 'asc' or\
          \ 'desc'. Defaults to 'asc'."
        required: false
        type: "string"
      - name: "size"
        in: "query"
        description: "From the paginate request. Number of rows to fetch, starting\
          \ from start. Defaults to 10."
        required: false
        type: "integer"
        format: "int32"
      - name: "sort"
        in: "query"
        description: "Property to sort the results on"
        required: false
        type: "string"
      - name: "start"
        in: "query"
        description: "From the paginate request. Index of the first row to fetch.\
          \ Defaults to 0."
        required: false
        type: "integer"
        format: "int32"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/DataResponseHistoricAgentInstanceKnowledgeBaseLinkResponse"
        400:
          description: "Indicates the request had some invalid arguments."
        403:
          description: "Indicates that the user does not have access to the agent\
            \ instance."
        404:
          description: "Indicates that agent instance does not exist or the user does\
            \ not have access to it."
      security:
      - basicAuth: []
  /agent-history/historic-agent-instances:
    get:
      tags:
      - "Historic Agent Instances"
      summary: "Query historic agent instances"
      description: ""
      operationId: "queryAgentInstances"
      produces:
      - "application/json"
      parameters:
      - name: "agentDefinitionId"
        in: "query"
        description: "Filter historic agent instances based on the agent definition\
          \ id"
        required: false
        type: "string"
      - name: "id"
        in: "query"
        description: "Filter historic agent instances based on the agent instance\
          \ id"
        required: false
        type: "string"
      - name: "order"
        in: "query"
        description: "From the paginate request.  The sort order, either 'asc' or\
          \ 'desc'. Defaults to 'asc'."
        required: false
        type: "string"
      - name: "referenceId"
        in: "query"
        description: "Filter historic agent instances based on the reference id"
        required: false
        type: "string"
      - name: "referenceType"
        in: "query"
        description: "Filter historic agent instances based on the reference type"
        required: false
        type: "string"
      - name: "size"
        in: "query"
        description: "From the paginate request. Number of rows to fetch, starting\
          \ from start. Defaults to 10."
        required: false
        type: "integer"
        format: "int32"
      - name: "sort"
        in: "query"
        description: "Property to sort the results on"
        required: false
        type: "string"
      - name: "start"
        in: "query"
        description: "From the paginate request. Index of the first row to fetch.\
          \ Defaults to 0."
        required: false
        type: "integer"
        format: "int32"
      - name: "startUserId"
        in: "query"
        description: "Filter historic agent instances started by the given user"
        required: false
        type: "string"
      - name: "tenantId"
        in: "query"
        description: "Filter historic agent instances based on the tenant id"
        required: false
        type: "string"
      - name: "tenantIdLike"
        in: "query"
        description: "Filter historic agent instances based on a tenant id like the\
          \ given one"
        required: false
        type: "string"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/DataResponseHistoricAgentInstanceResponse"
        400:
          description: "Indicates the request had some invalid arguments."
      security:
      - basicAuth: []
  /agent-history/historic-agent-instances/{agentInstanceId}:
    get:
      tags:
      - "Historic Agent Instances"
      summary: "Get historic agent instance details"
      description: ""
      operationId: "getHistoricAgentInstance"
      produces:
      - "application/json"
      parameters:
      - name: "agentInstanceId"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/HistoricAgentInstanceResponse"
        400:
          description: "Indicates the request had some invalid arguments."
        403:
          description: "Indicates that the user does not have access to the historic\
            \ agent instance."
        404:
          description: "Indicates that agent instance does not exist or the user does\
            \ not have access to it."
      security:
      - basicAuth: []
  /agent-history/historic-agent-instances/{agentInstanceId}/knowledge-base-links:
    get:
      tags:
      - "Historic Agent Instances"
      summary: "Get historic agent instance knowledge base links"
      description: ""
      operationId: "getHistoricAgentInstanceKnowledgeBaseLinks"
      produces:
      - "application/json"
      parameters:
      - name: "agentInstanceId"
        in: "path"
        required: true
        type: "string"
      - name: "order"
        in: "query"
        description: "From the paginate request.  The sort order, either 'asc' or\
          \ 'desc'. Defaults to 'asc'."
        required: false
        type: "string"
      - name: "size"
        in: "query"
        description: "From the paginate request. Number of rows to fetch, starting\
          \ from start. Defaults to 10."
        required: false
        type: "integer"
        format: "int32"
      - name: "sort"
        in: "query"
        description: "Property to sort the results on"
        required: false
        type: "string"
      - name: "start"
        in: "query"
        description: "From the paginate request. Index of the first row to fetch.\
          \ Defaults to 0."
        required: false
        type: "integer"
        format: "int32"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/DataResponseHistoricAgentInstanceKnowledgeBaseLinkResponse"
        400:
          description: "Indicates the request had some invalid arguments."
        403:
          description: "Indicates that the user does not have access to the agent\
            \ instance."
        404:
          description: "Indicates that agent instance does not exist or the user does\
            \ not have access to it."
      security:
      - basicAuth: []
  /agent-management/agent-connections:
    get:
      tags:
      - "Agent Connections"
      summary: "Query Agent connections"
      description: ""
      operationId: "queryAgentConnections"
      parameters:
      - name: "id"
        in: "query"
        description: "Only return Agent connections with the given id."
        required: false
        type: "string"
      - name: "key"
        in: "query"
        description: "Only return Agent connections with the given key."
        required: false
        type: "string"
      - name: "keyLikeIgnoreCase"
        in: "query"
        description: "Only return Agent connections with a key like the given value,\
          \ case-insensitive."
        required: false
        type: "string"
      - name: "order"
        in: "query"
        description: "From the paginate request.  The sort order, either 'asc' or\
          \ 'desc'. Defaults to 'asc'."
        required: false
        type: "string"
      - name: "size"
        in: "query"
        description: "From the paginate request. Number of rows to fetch, starting\
          \ from start. Defaults to 10."
        required: false
        type: "integer"
        format: "int32"
      - name: "sort"
        in: "query"
        description: "Property to sort the results on"
        required: false
        type: "string"
      - name: "start"
        in: "query"
        description: "From the paginate request. Index of the first row to fetch.\
          \ Defaults to 0."
        required: false
        type: "integer"
        format: "int32"
      - name: "tenantId"
        in: "query"
        description: "Only return Agent connections from the given tenant."
        required: false
        type: "string"
      - name: "tenantIdLike"
        in: "query"
        description: "Only return Agent connections with a tenant id like the given\
          \ one."
        required: false
        type: "string"
      responses:
        200:
          description: "Indicates that the request was successful"
          schema:
            $ref: "#/definitions/DataResponseAgentConnectionResponse"
        400:
          description: "Indicates the request parameters are incomplete or contain\
            \ illegal values."
        403:
          description: "Indicates that the user doing the request does not have the\
            \ required permissions for viewing Agent connections"
      security:
      - basicAuth: []
    post:
      tags:
      - "Agent Connections"
      summary: "Create an Agent connection"
      description: ""
      operationId: "createAgentConnection"
      parameters:
      - in: "body"
        name: "body"
        required: false
        schema:
          $ref: "#/definitions/AgentConnectionCreateRequest"
      responses:
        201:
          description: "Indicates that the Agent connection was created"
          schema:
            $ref: "#/definitions/AgentConnectionResponse"
        400:
          description: "Indicates the request parameters are incomplete or contain\
            \ illegal values."
        403:
          description: "Indicates that the user doing the request does not have the\
            \ required permissions for creating an Agent connection"
        409:
          description: "Indicates that an Agent connection with the given key already\
            \ exists in the tenant"
      security:
      - basicAuth: []
  /agent-management/agent-connections/{agentConnectionId}:
    get:
      tags:
      - "Agent Connections"
      summary: "Get Agent connection by id"
      description: ""
      operationId: "getAgentConnection"
      produces:
      - "application/json"
      parameters:
      - name: "agentConnectionId"
        in: "path"
        description: "Unique identifier of the Agent connection"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates that the request was successful"
          schema:
            $ref: "#/definitions/AgentConnectionResponse"
        403:
          description: "Indicates that the user doing the request does not have the\
            \ required permissions for viewing Agent connections"
        404:
          description: "Indicates that the Agent connection does not exist"
      security:
      - basicAuth: []
    put:
      tags:
      - "Agent Connections"
      summary: "Update an Agent connection"
      description: ""
      operationId: "updateAgentConnection"
      parameters:
      - name: "agentConnectionId"
        in: "path"
        required: true
        type: "string"
      - in: "body"
        name: "body"
        required: false
        schema:
          $ref: "#/definitions/AgentConnectionUpdateRequest"
      responses:
        200:
          description: "Indicates that the Agent connection was updated"
          schema:
            $ref: "#/definitions/AgentConnectionResponse"
        400:
          description: "Indicates the request parameters are incomplete or contain\
            \ illegal values."
        403:
          description: "Indicates that the user doing the request does not have the\
            \ required permissions for updating an Agent connection"
        404:
          description: "Indicates that the Agent connection does not exist"
      security:
      - basicAuth: []
    delete:
      tags:
      - "Agent Connections"
      summary: "Delete an Agent connection"
      description: ""
      operationId: "deleteAgentConnection"
      parameters:
      - name: "agentConnectionId"
        in: "path"
        required: true
        type: "string"
      responses:
        204:
          description: "Indicates that the Agent connection was deleted"
        403:
          description: "Indicates that the user doing the request does not have the\
            \ required permissions for deleting an Agent connection"
        404:
          description: "Indicates that the Agent connection does not exist"
      security:
      - basicAuth: []
  /agent-management/agent-model-prices:
    get:
      tags:
      - "Agent Model Pricing"
      summary: "List agent model prices"
      description: ""
      operationId: "list"
      parameters:
      - name: "raw"
        in: "query"
        required: false
        type: "boolean"
      - name: "tenantId"
        in: "query"
        required: false
        type: "string"
      responses:
        200:
          description: "Indicates that the request was successful"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/AgentModelPriceResponse"
      security:
      - basicAuth: []
    post:
      tags:
      - "Agent Model Pricing"
      summary: "Create an agent model price"
      description: ""
      operationId: "create"
      parameters:
      - in: "body"
        name: "body"
        required: false
        schema:
          $ref: "#/definitions/AgentModelPriceRequest"
      - name: "tenantId"
        in: "query"
        required: false
        type: "string"
      responses:
        201:
          description: "Indicates that the agent model price was created"
          schema:
            $ref: "#/definitions/AgentModelPriceResponse"
        400:
          description: "Indicates the request parameters are incomplete or contain\
            \ illegal values."
        403:
          description: "Indicates that the user doing the request does not have the\
            \ required permissions for creating an agent model price"
        409:
          description: "Indicates that an agent model price with the given prefix\
            \ already exists"
      security:
      - basicAuth: []
  /agent-management/agent-model-prices/{modelPrefix}:
    get:
      tags:
      - "Agent Model Pricing"
      summary: "Get an agent model price by model prefix"
      description: ""
      operationId: "get"
      parameters:
      - name: "modelPrefix"
        in: "path"
        required: true
        type: "string"
      - name: "tenantId"
        in: "query"
        required: false
        type: "string"
      responses:
        200:
          description: "Indicates that the request was successful"
          schema:
            $ref: "#/definitions/AgentModelPriceResponse"
        404:
          description: "Indicates that no price exists for the given model prefix"
      security:
      - basicAuth: []
    put:
      tags:
      - "Agent Model Pricing"
      summary: "Create or update an agent model price"
      description: ""
      operationId: "update"
      parameters:
      - name: "modelPrefix"
        in: "path"
        required: true
        type: "string"
      - in: "body"
        name: "body"
        required: false
        schema:
          $ref: "#/definitions/AgentModelPriceRequest"
      - name: "tenantId"
        in: "query"
        required: false
        type: "string"
      responses:
        200:
          description: "Indicates that the agent model price was created or updated"
          schema:
            $ref: "#/definitions/AgentModelPriceResponse"
        400:
          description: "Indicates the request parameters are incomplete or contain\
            \ illegal values."
        403:
          description: "Indicates that the user doing the request does not have the\
            \ required permissions for updating an agent model price"
      security:
      - basicAuth: []
    delete:
      tags:
      - "Agent Model Pricing"
      summary: "Delete an agent model price"
      description: ""
      operationId: "delete"
      parameters:
      - name: "modelPrefix"
        in: "path"
        required: true
        type: "string"
      - name: "tenantId"
        in: "query"
        required: false
        type: "string"
      responses:
        204:
          description: "Indicates that the agent model price was deleted"
        403:
          description: "Indicates that the user doing the request does not have the\
            \ required permissions for deleting an agent model price"
      security:
      - basicAuth: []
  /agent-management/deadletter-jobs:
    get:
      tags:
      - "Jobs"
      summary: "List deadletter jobs"
      description: ""
      operationId: "listDeadLetterJobs"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "query"
        description: "Only return job with the given id"
        required: false
        type: "string"
      - name: "scopeId"
        in: "query"
        description: "Only return jobs part of a scope with the given id"
        required: false
        type: "string"
      - name: "withoutScopeId"
        in: "query"
        description: "If true, only returns jobs without a scope id set. If false,\
          \ the withoutScopeId parameter is ignored."
        required: false
        type: "boolean"
      - name: "subScopeId"
        in: "query"
        description: "Only return jobs part of a sub scope with the given id"
        required: false
        type: "string"
      - name: "scopeDefinitionId"
        in: "query"
        description: "Only return jobs with the given scope definition id"
        required: false
        type: "string"
      - name: "scopeType"
        in: "query"
        description: "Only return jobs with the given scope type"
        required: false
        type: "string"
      - name: "elementId"
        in: "query"
        description: "Only return jobs with the given element id"
        required: false
        type: "string"
      - name: "elementName"
        in: "query"
        description: "Only return jobs with the given element name"
        required: false
        type: "string"
      - name: "timersOnly"
        in: "query"
        description: "If true, only return jobs which are timers. If false, this parameter\
          \ is ignored. Cannot be used together with 'messagesOnly'."
        required: false
        type: "boolean"
      - name: "messagesOnly"
        in: "query"
        description: "If true, only return jobs which are messages. If false, this\
          \ parameter is ignored. Cannot be used together with 'timersOnly'"
        required: false
        type: "boolean"
      - name: "withException"
        in: "query"
        description: "If true, only return jobs for which an exception occurred while\
          \ executing it. If false, this parameter is ignored."
        required: false
        type: "boolean"
      - name: "dueBefore"
        in: "query"
        description: "Only return jobs which are due to be executed before the given\
          \ date. Jobs without duedate are never returned using this parameter."
        required: false
        type: "string"
        format: "date-time"
      - name: "dueAfter"
        in: "query"
        description: "Only return jobs which are due to be executed after the given\
          \ date. Jobs without duedate are never returned using this parameter."
        required: false
        type: "string"
        format: "date-time"
      - name: "exceptionMessage"
        in: "query"
        description: "Only return jobs with the given exception message"
        required: false
        type: "string"
      - name: "tenantId"
        in: "query"
        description: "Only return jobs with the given tenantId."
        required: false
        type: "string"
      - name: "tenantIdLike"
        in: "query"
        description: "Only return jobs with a tenantId like the given value."
        required: false
        type: "string"
      - name: "withoutTenantId"
        in: "query"
        description: "If true, only returns jobs without a tenantId set. If false,\
          \ the withoutTenantId parameter is ignored."
        required: false
        type: "boolean"
      - name: "locked"
        in: "query"
        description: "If true, only return jobs which are locked.  If false, this\
          \ parameter is ignored."
        required: false
        type: "boolean"
      - name: "unlocked"
        in: "query"
        description: "If true, only return jobs which are unlocked. If false, this\
          \ parameter is ignored."
        required: false
        type: "boolean"
      - name: "withoutProcessInstanceId"
        in: "query"
        description: "If true, only returns jobs without a process instance id set.\
          \ If false, the withoutProcessInstanceId parameter is ignored."
        required: false
        type: "boolean"
      - name: "sort"
        in: "query"
        description: "Property to sort on, to be used together with the order."
        required: false
        type: "string"
        enum:
        - "id"
        - "dueDate"
        - "executionId"
        - "processInstanceId"
        - "retries"
        - "tenantId"
      responses:
        200:
          description: "Indicates the requested jobs were returned."
          schema:
            $ref: "#/definitions/DataResponseJobResponse"
        400:
          description: "Indicates an illegal value has been used in a url query parameter\
            \ or the both 'messagesOnly' and 'timersOnly' are used as parameters.\
            \ Status description contains additional details about the error."
      security:
      - basicAuth: []
    post:
      tags:
      - "Jobs"
      summary: "Move a bulk of deadletter jobs. Accepts 'move' and 'moveToHistoryJob'\
        \ as action."
      description: ""
      operationId: "executeDeadLetterJobAction"
      parameters:
      - in: "body"
        name: "body"
        required: false
        schema:
          $ref: "#/definitions/BulkMoveDeadLetterActionRequest"
      responses:
        204:
          description: "Indicates the dead letter jobs where moved. Response-body\
            \ is intentionally empty."
        500:
          description: "Indicates the an exception occurred while executing the job.\
            \ The status-description contains additional detail about the error. The\
            \ full error-stacktrace can be fetched later on if needed."
      security:
      - basicAuth: []
  /agent-management/deadletter-jobs/{jobId}:
    get:
      tags:
      - "Jobs"
      summary: "Get a single deadletter job"
      description: ""
      operationId: "getDeadletterJob"
      produces:
      - "application/json"
      parameters:
      - name: "jobId"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the suspended job exists and is returned."
          schema:
            $ref: "#/definitions/JobResponse"
        404:
          description: "Indicates the requested job does not exist."
      security:
      - basicAuth: []
    post:
      tags:
      - "Jobs"
      summary: "Move a single deadletter job. Accepts 'move' and 'moveToHistoryJob'\
        \ as action."
      description: ""
      operationId: "executeDeadLetterJobAction"
      parameters:
      - name: "jobId"
        in: "path"
        required: true
        type: "string"
      - in: "body"
        name: "body"
        required: false
        schema:
          $ref: "#/definitions/RestActionRequest"
      responses:
        204:
          description: "Indicates the dead letter job was moved. Response-body is\
            \ intentionally empty."
        404:
          description: "Indicates the requested job was not found."
        500:
          description: "Indicates the an exception occurred while executing the job.\
            \ The status-description contains additional detail about the error. The\
            \ full error-stacktrace can be fetched later on if needed."
      security:
      - basicAuth: []
    delete:
      tags:
      - "Jobs"
      summary: "Delete a deadletter job"
      description: ""
      operationId: "deleteDeadLetterJob"
      parameters:
      - name: "jobId"
        in: "path"
        required: true
        type: "string"
      responses:
        204:
          description: "Indicates the job was found and has been deleted. Response-body\
            \ is intentionally empty."
        404:
          description: "Indicates the requested job was not found."
      security:
      - basicAuth: []
  /agent-management/deadletter-jobs/{jobId}/exception-stacktrace:
    get:
      tags:
      - "Jobs"
      summary: "Get the exception stacktrace for a deadletter job"
      description: ""
      operationId: "getDeadLetterJobStacktrace"
      parameters:
      - name: "jobId"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the requested job was not found and the stacktrace\
            \ has been returned. The response contains the raw stacktrace and always\
            \ has a Content-type of text/plain."
          schema:
            type: "string"
        404:
          description: "Indicates the requested job was not found or the job does\
            \ not have an exception stacktrace. Status-description contains additional\
            \ information about the error."
      security:
      - basicAuth: []
  /agent-management/jobs:
    get:
      tags:
      - "Jobs"
      summary: "List jobs"
      description: ""
      operationId: "listJobs"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "query"
        description: "Only return job with the given id"
        required: false
        type: "string"
      - name: "scopeId"
        in: "query"
        description: "Only return jobs part of a scope with the given id"
        required: false
        type: "string"
      - name: "withoutScopeId"
        in: "query"
        description: "If true, only returns jobs without a scope id set. If false,\
          \ the withoutScopeId parameter is ignored."
        required: false
        type: "boolean"
      - name: "subScopeId"
        in: "query"
        description: "Only return jobs part of a sub scope with the given id"
        required: false
        type: "string"
      - name: "scopeDefinitionId"
        in: "query"
        description: "Only return jobs with the given scope definition id"
        required: false
        type: "string"
      - name: "scopeType"
        in: "query"
        description: "Only return jobs with the given scope type"
        required: false
        type: "string"
      - name: "elementId"
        in: "query"
        description: "Only return jobs with the given element id"
        required: false
        type: "string"
      - name: "elementName"
        in: "query"
        description: "Only return jobs with the given element name"
        required: false
        type: "string"
      - name: "timersOnly"
        in: "query"
        description: "If true, only return jobs which are timers. If false, this parameter\
          \ is ignored. Cannot be used together with 'messagesOnly'."
        required: false
        type: "boolean"
      - name: "messagesOnly"
        in: "query"
        description: "If true, only return jobs which are messages. If false, this\
          \ parameter is ignored. Cannot be used together with 'timersOnly'"
        required: false
        type: "boolean"
      - name: "withException"
        in: "query"
        description: "If true, only return jobs for which an exception occurred while\
          \ executing it. If false, this parameter is ignored."
        required: false
        type: "boolean"
      - name: "dueBefore"
        in: "query"
        description: "Only return jobs which are due to be executed before the given\
          \ date. Jobs without duedate are never returned using this parameter."
        required: false
        type: "string"
        format: "date-time"
      - name: "dueAfter"
        in: "query"
        description: "Only return jobs which are due to be executed after the given\
          \ date. Jobs without duedate are never returned using this parameter."
        required: false
        type: "string"
        format: "date-time"
      - name: "exceptionMessage"
        in: "query"
        description: "Only return jobs with the given exception message"
        required: false
        type: "string"
      - name: "tenantId"
        in: "query"
        description: "Only return jobs with the given tenantId."
        required: false
        type: "string"
      - name: "tenantIdLike"
        in: "query"
        description: "Only return jobs with a tenantId like the given value."
        required: false
        type: "string"
      - name: "withoutTenantId"
        in: "query"
        description: "If true, only returns jobs without a tenantId set. If false,\
          \ the withoutTenantId parameter is ignored."
        required: false
        type: "boolean"
      - name: "locked"
        in: "query"
        description: "If true, only return jobs which are locked.  If false, this\
          \ parameter is ignored."
        required: false
        type: "boolean"
      - name: "unlocked"
        in: "query"
        description: "If true, only return jobs which are unlocked. If false, this\
          \ parameter is ignored."
        required: false
        type: "boolean"
      - name: "withoutProcessInstanceId"
        in: "query"
        description: "If true, only returns jobs without a process instance id set.\
          \ If false, the withoutProcessInstanceId parameter is ignored."
        required: false
        type: "boolean"
      - name: "sort"
        in: "query"
        description: "Property to sort on, to be used together with the order."
        required: false
        type: "string"
        enum:
        - "id"
        - "dueDate"
        - "executionId"
        - "processInstanceId"
        - "retries"
        - "tenantId"
      responses:
        200:
          description: "Indicates the requested jobs were returned."
          schema:
            $ref: "#/definitions/DataResponseJobResponse"
        400:
          description: "Indicates an illegal value has been used in a url query parameter\
            \ or the both 'messagesOnly' and 'timersOnly' are used as parameters.\
            \ Status description contains additional details about the error."
      security:
      - basicAuth: []
  /agent-management/jobs/{jobId}:
    get:
      tags:
      - "Jobs"
      summary: "Get a single job"
      description: ""
      operationId: "getJob"
      produces:
      - "application/json"
      parameters:
      - name: "jobId"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the job exists and is returned."
          schema:
            $ref: "#/definitions/JobResponse"
        404:
          description: "Indicates the requested job does not exist."
      security:
      - basicAuth: []
    post:
      tags:
      - "Jobs"
      summary: "Execute a single job"
      description: ""
      operationId: "executeJobAction"
      parameters:
      - name: "jobId"
        in: "path"
        required: true
        type: "string"
      - in: "body"
        name: "body"
        required: false
        schema:
          $ref: "#/definitions/RestActionRequest"
      responses:
        204:
          description: "Indicates the job was executed. Response-body is intentionally\
            \ empty."
        404:
          description: "Indicates the requested job was not found."
        500:
          description: "Indicates the an exception occurred while executing the job.\
            \ The status-description contains additional detail about the error. The\
            \ full error-stacktrace can be fetched later on if needed."
      security:
      - basicAuth: []
    delete:
      tags:
      - "Jobs"
      summary: "Delete a job"
      description: ""
      operationId: "deleteJob"
      parameters:
      - name: "jobId"
        in: "path"
        required: true
        type: "string"
      responses:
        204:
          description: "Indicates the job was found and has been deleted. Response-body\
            \ is intentionally empty."
        404:
          description: "Indicates the requested job was not found.."
      security:
      - basicAuth: []
  /agent-management/jobs/{jobId}/exception-stacktrace:
    get:
      tags:
      - "Jobs"
      summary: "Get the exception stacktrace for a job"
      description: ""
      operationId: "getJobStacktrace"
      parameters:
      - name: "jobId"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the requested job was not found and the stacktrace\
            \ has been returned. The response contains the raw stacktrace and always\
            \ has a Content-type of text/plain."
          schema:
            type: "string"
        404:
          description: "Indicates the requested job was not found or the job does\
            \ not have an exception stacktrace. Status-description contains additional\
            \ information about the error."
      security:
      - basicAuth: []
  /agent-management/timer-jobs:
    get:
      tags:
      - "Jobs"
      summary: "List timer jobs"
      description: ""
      operationId: "listTimerJobs"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "query"
        description: "Only return job with the given id"
        required: false
        type: "string"
      - name: "scopeId"
        in: "query"
        description: "Only return jobs part of a scope with the given id"
        required: false
        type: "string"
      - name: "withoutScopeId"
        in: "query"
        description: "If true, only returns jobs without a scope id set. If false,\
          \ the withoutScopeId parameter is ignored."
        required: false
        type: "boolean"
      - name: "subScopeId"
        in: "query"
        description: "Only return jobs part of a sub scope with the given id"
        required: false
        type: "string"
      - name: "scopeDefinitionId"
        in: "query"
        description: "Only return jobs with the given scope definition id"
        required: false
        type: "string"
      - name: "scopeType"
        in: "query"
        description: "Only return jobs with the given scope type"
        required: false
        type: "string"
      - name: "elementId"
        in: "query"
        description: "Only return jobs with the given element id"
        required: false
        type: "string"
      - name: "elementName"
        in: "query"
        description: "Only return jobs with the given element name"
        required: false
        type: "string"
      - name: "timersOnly"
        in: "query"
        description: "If true, only return jobs which are timers. If false, this parameter\
          \ is ignored. Cannot be used together with 'messagesOnly'."
        required: false
        type: "boolean"
      - name: "messagesOnly"
        in: "query"
        description: "If true, only return jobs which are messages. If false, this\
          \ parameter is ignored. Cannot be used together with 'timersOnly'"
        required: false
        type: "boolean"
      - name: "withException"
        in: "query"
        description: "If true, only return jobs for which an exception occurred while\
          \ executing it. If false, this parameter is ignored."
        required: false
        type: "boolean"
      - name: "dueBefore"
        in: "query"
        description: "Only return jobs which are due to be executed before the given\
          \ date. Jobs without duedate are never returned using this parameter."
        required: false
        type: "string"
        format: "date-time"
      - name: "dueAfter"
        in: "query"
        description: "Only return jobs which are due to be executed after the given\
          \ date. Jobs without duedate are never returned using this parameter."
        required: false
        type: "string"
        format: "date-time"
      - name: "exceptionMessage"
        in: "query"
        description: "Only return jobs with the given exception message"
        required: false
        type: "string"
      - name: "tenantId"
        in: "query"
        description: "Only return jobs with the given tenantId."
        required: false
        type: "string"
      - name: "tenantIdLike"
        in: "query"
        description: "Only return jobs with a tenantId like the given value."
        required: false
        type: "string"
      - name: "withoutTenantId"
        in: "query"
        description: "If true, only returns jobs without a tenantId set. If false,\
          \ the withoutTenantId parameter is ignored."
        required: false
        type: "boolean"
      - name: "locked"
        in: "query"
        description: "If true, only return jobs which are locked.  If false, this\
          \ parameter is ignored."
        required: false
        type: "boolean"
      - name: "unlocked"
        in: "query"
        description: "If true, only return jobs which are unlocked. If false, this\
          \ parameter is ignored."
        required: false
        type: "boolean"
      - name: "withoutProcessInstanceId"
        in: "query"
        description: "If true, only returns jobs without a process instance id set.\
          \ If false, the withoutProcessInstanceId parameter is ignored."
        required: false
        type: "boolean"
      - name: "sort"
        in: "query"
        description: "Property to sort on, to be used together with the order."
        required: false
        type: "string"
        enum:
        - "id"
        - "dueDate"
        - "executionId"
        - "processInstanceId"
        - "retries"
        - "tenantId"
      responses:
        200:
          description: "Indicates the requested jobs were returned."
          schema:
            $ref: "#/definitions/DataResponseJobResponse"
        400:
          description: "Indicates an illegal value has been used in a url query parameter\
            \ or the both 'messagesOnly' and 'timersOnly' are used as parameters.\
            \ Status description contains additional details about the error."
      security:
      - basicAuth: []
  /agent-management/timer-jobs/{jobId}:
    get:
      tags:
      - "Jobs"
      summary: "Get a single timer job"
      description: ""
      operationId: "getTimerJob"
      produces:
      - "application/json"
      parameters:
      - name: "jobId"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the timer job exists and is returned."
          schema:
            $ref: "#/definitions/JobResponse"
        404:
          description: "Indicates the requested job does not exist."
      security:
      - basicAuth: []
    post:
      tags:
      - "Jobs"
      summary: "Execute a single job action (move or reschedule)"
      description: ""
      operationId: "executeTimerJobAction"
      parameters:
      - name: "jobId"
        in: "path"
        required: true
        type: "string"
      - in: "body"
        name: "body"
        required: false
        schema:
          $ref: "#/definitions/TimerJobActionRequest"
      responses:
        204:
          description: "Indicates the timer job action was executed. Response-body\
            \ is intentionally empty."
        404:
          description: "Indicates the requested job was not found."
        500:
          description: "Indicates the an exception occurred while executing the job.\
            \ The status-description contains additional detail about the error. The\
            \ full error-stacktrace can be fetched later on if needed."
      security:
      - basicAuth: []
    delete:
      tags:
      - "Jobs"
      summary: "Delete a timer job"
      description: ""
      operationId: "deleteTimerJob"
      parameters:
      - name: "jobId"
        in: "path"
        required: true
        type: "string"
      responses:
        204:
          description: "Indicates the job was found and has been deleted. Response-body\
            \ is intentionally empty."
        404:
          description: "Indicates the requested job was not found."
      security:
      - basicAuth: []
  /agent-management/timer-jobs/{jobId}/exception-stacktrace:
    get:
      tags:
      - "Jobs"
      summary: "Get the exception stacktrace for a timer job"
      description: ""
      operationId: "getTimerJobStacktrace"
      parameters:
      - name: "jobId"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the requested job was not found and the stacktrace\
            \ has been returned. The response contains the raw stacktrace and always\
            \ has a Content-type of text/plain."
          schema:
            type: "string"
        404:
          description: "Indicates the requested job was not found or the job does\
            \ not have an exception stacktrace. Status-description contains additional\
            \ information about the error."
      security:
      - basicAuth: []
  /agent-repository/agent-definitions:
    get:
      tags:
      - "Agent Definitions"
      summary: "Query agent definitions"
      description: ""
      operationId: "queryAgentDefinitions"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "query"
        description: "Only return agent definitions with the given id."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "Only return agent definitions with the given name."
        required: false
        type: "string"
      - name: "nameLike"
        in: "query"
        description: "Only return agent definitions with a name like the given name."
        required: false
        type: "string"
      - name: "nameLikeIgnoreCase"
        in: "query"
        description: "Only return agent definitions with a name like the given name\
          \ ignoring the case."
        required: false
        type: "string"
      - name: "key"
        in: "query"
        description: "Only return agent definitions with the given key."
        required: false
        type: "string"
      - name: "keyLike"
        in: "query"
        description: "Only return agent definitions with a key like the given key."
        required: false
        type: "string"
      - name: "deploymentId"
        in: "query"
        description: "Only return agent definitions with the given deployment id."
        required: false
        type: "string"
      - name: "version"
        in: "query"
        description: "Only return agent definitions with the given version."
        required: false
        type: "integer"
      - name: "latest"
        in: "query"
        description: "Only return agent definitions with the latest version."
        required: false
        type: "boolean"
      - name: "type"
        in: "query"
        description: "Only return agent definitions with the given type."
        required: false
        type: "string"
      - name: "apiEnabled"
        in: "query"
        description: "Only return agent definitions which are startable over REST."
        required: false
        type: "string"
      - name: "tenantId"
        in: "query"
        description: "Only return agent definitions with the given tenant id."
        required: false
        type: "string"
      - name: "sort"
        in: "query"
        description: "Property to sort on, to be used together with the order."
        required: false
        type: "string"
        enum:
        - "id"
        - "name"
        - "key"
        - "tenantId"
      responses:
        200:
          description: "successful operation"
          schema:
            $ref: "#/definitions/DataResponseAgentDefinitionResponse"
      security:
      - basicAuth: []
  /agent-repository/agent-definitions/key/{agentDefinitionKey}:
    get:
      tags:
      - "Agent Definitions"
      summary: "Get agent definition by key"
      description: ""
      operationId: "getAgentDefinitionByKey"
      produces:
      - "application/json"
      parameters:
      - name: "agentDefinitionKey"
        in: "path"
        description: "Key of the agent definition"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the agent definition was found and returned."
          schema:
            $ref: "#/definitions/AgentDefinitionResponse"
        403:
          description: "Indicates the user does not have the rights to query for the\
            \ agent definition."
        404:
          description: "Indicates the requested agent definition was not found."
      security:
      - basicAuth: []
  /agent-repository/agent-definitions/{agentDefinitionId}:
    get:
      tags:
      - "Agent Definitions"
      summary: "Get agent definition"
      description: ""
      operationId: "getAgentDefinition"
      produces:
      - "application/json"
      parameters:
      - name: "agentDefinitionId"
        in: "path"
        description: "Unique identifier of the agent definition"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the agent definition was found and returned."
          schema:
            $ref: "#/definitions/AgentDefinitionResponse"
        403:
          description: "Indicates the user does not have the rights to query for the\
            \ agent definition."
        404:
          description: "Indicates the requested agent definition was not found."
      security:
      - basicAuth: []
  /agent-repository/deployments:
    get:
      tags:
      - "Agent Deployments"
      summary: "List of Agent Deployments"
      description: ""
      operationId: "listAgentDeployments"
      produces:
      - "application/json"
      parameters:
      - name: "name"
        in: "query"
        description: "Only return action deployments with the given name."
        required: false
        type: "string"
      - name: "nameLike"
        in: "query"
        description: "Only return action deployments with a name like the given name."
        required: false
        type: "string"
      - name: "category"
        in: "query"
        description: "Only return action deployments with the given category."
        required: false
        type: "string"
      - name: "categoryNotEquals"
        in: "query"
        description: "Only return action deployments which don’t have the given category."
        required: false
        type: "string"
      - name: "tenantId"
        in: "query"
        description: "Only return action deployments with the given tenantId."
        required: false
        type: "string"
      - name: "tenantIdLike"
        in: "query"
        description: "Only return action deployments with a tenantId like the given\
          \ value."
        required: false
        type: "string"
      - name: "withoutTenantId"
        in: "query"
        description: "If true, only returns action deployments without a tenantId\
          \ set. If false, the withoutTenantId parameter is ignored."
        required: false
        type: "boolean"
      - name: "sort"
        in: "query"
        description: "Property to sort on, to be used together with the order."
        required: false
        type: "string"
        enum:
        - "id"
        - "name"
        - "deployTime"
        - "tenantId"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/DataResponseAgentDeploymentResponse"
      security:
      - basicAuth: []
    post:
      tags:
      - "Agent Deployments"
      summary: "Create a new agent deployment"
      description: "The request body should contain data of type multipart/form-data.\
        \ There should be exactly one file in the request, any additional files will\
        \ be ignored. The deployment name is the name of the file-field passed in.\
        \ Make sure the file-name ends with .agent or .knowledgeBase."
      operationId: "uploadDeployment"
      consumes:
      - "multipart/form-data"
      produces:
      - "application/json"
      parameters:
      - name: "tenantId"
        in: "query"
        required: false
        type: "string"
      responses:
        201:
          description: "Indicates the agent deployment was created."
          schema:
            $ref: "#/definitions/AgentDeploymentResponse"
        400:
          description: "Indicates there was no content present in the request body\
            \ or the content mime-type is not supported for agent deployment. The\
            \ status-description contains additional information."
      security:
      - basicAuth: []
  /agent-repository/deployments/{deploymentId}:
    get:
      tags:
      - "Agent Deployments"
      summary: "Get an agent deployment"
      description: ""
      operationId: "getDeployment"
      produces:
      - "application/json"
      parameters:
      - name: "deploymentId"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the agent deployment was found and returned."
          schema:
            $ref: "#/definitions/AgentDeploymentResponse"
        404:
          description: "Indicates the requested agent deployment was not found."
      security:
      - basicAuth: []
    delete:
      tags:
      - "Agent Deployments"
      summary: "Delete an agent deployment"
      description: ""
      operationId: "deleteDeployment"
      produces:
      - "application/json"
      parameters:
      - name: "deploymentId"
        in: "path"
        required: true
        type: "string"
      responses:
        204:
          description: "Indicates the agent deployment was found and has been deleted.\
            \ Response-body is intentionally empty."
        404:
          description: "Indicates the requested agent deployment was not found."
      security:
      - basicAuth: []
  /agent-repository/deployments/{deploymentId}/resourcedata/{resourceName}:
    get:
      tags:
      - "Agent Deployments"
      summary: "Get an agent deployment resource content"
      description: "The response body will contain the binary resource-content for\
        \ the requested resource. The response content-type will be the same as the\
        \ type returned in the resources mimeType property. Also, a content-disposition\
        \ header is set, allowing browsers to download the file instead of displaying\
        \ it."
      operationId: "getAgentDeploymentResource"
      parameters:
      - name: "deploymentId"
        in: "path"
        required: true
        type: "string"
      - name: "resourceName"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates both agent deployment and resource have been found\
            \ and the resource data has been returned."
          schema:
            type: "array"
            items:
              type: "string"
              format: "byte"
        404:
          description: "Indicates the requested agent deployment was not found or\
            \ there is no resource with the given id present in the agent deployment.\
            \ The status-description contains additional information."
      security:
      - basicAuth: []
  /agent-repository/knowledge-base-definitions:
    get:
      tags:
      - "Knowledge Base Definitions"
      summary: "Query knowledge base definitions"
      description: ""
      operationId: "queryKnowledgeBaseDefinitions"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "query"
        description: "Only return knowledge base definitions with the given id."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "Only return knowledge base definitions with the given name."
        required: false
        type: "string"
      - name: "nameLike"
        in: "query"
        description: "Only return knowledge base definitions with a name like the\
          \ given name."
        required: false
        type: "string"
      - name: "nameLikeIgnoreCase"
        in: "query"
        description: "Only return knowledge base definitions with a name like the\
          \ given name ignoring the case."
        required: false
        type: "string"
      - name: "key"
        in: "query"
        description: "Only return knowledge base definitions with the given key."
        required: false
        type: "string"
      - name: "keyLike"
        in: "query"
        description: "Only return knowledge base definitions with a key like the given\
          \ key."
        required: false
        type: "string"
      - name: "deploymentId"
        in: "query"
        description: "Only return knowledge base definitions with the given deployment\
          \ id."
        required: false
        type: "string"
      - name: "version"
        in: "query"
        description: "Only return knowledge base definitions with the given version."
        required: false
        type: "integer"
      - name: "latest"
        in: "query"
        description: "Only return knowledge base definitions with the latest version."
        required: false
        type: "boolean"
      - name: "tenantId"
        in: "query"
        description: "Only return knowledge base definitions with the given tenant\
          \ id."
        required: false
        type: "string"
      - name: "sort"
        in: "query"
        description: "Property to sort on, to be used together with the order."
        required: false
        type: "string"
        enum:
        - "id"
        - "name"
        - "key"
        - "tenantId"
      responses:
        200:
          description: "successful operation"
          schema:
            $ref: "#/definitions/DataResponseKnowledgeBaseDefinitionResponse"
      security:
      - basicAuth: []
  /agent-repository/knowledge-base-definitions/key/{knowledgeBaseDefinitionKey}:
    get:
      tags:
      - "Knowledge Base Definitions"
      summary: "Get knowledge base definition by key"
      description: ""
      operationId: "getKnowledgeBaseDefinitionByKey"
      produces:
      - "application/json"
      parameters:
      - name: "knowledgeBaseDefinitionKey"
        in: "path"
        description: "Key of the knowledge base definition"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the knowledge base definition was found and returned."
          schema:
            $ref: "#/definitions/KnowledgeBaseDefinitionResponse"
        403:
          description: "Indicates the user does not have the rights to query for the\
            \ knowledge base definition."
        404:
          description: "Indicates the requested knowledge base definition was not\
            \ found."
      security:
      - basicAuth: []
  /agent-repository/knowledge-base-definitions/{knowledgeBaseDefinitionId}:
    get:
      tags:
      - "Knowledge Base Definitions"
      summary: "Get knowledge base definition"
      description: ""
      operationId: "getKnowledgeBaseDefinition"
      produces:
      - "application/json"
      parameters:
      - name: "knowledgeBaseDefinitionId"
        in: "path"
        description: "Unique identifier of the knowledge base definition"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the knowledge base definition was found and returned."
          schema:
            $ref: "#/definitions/KnowledgeBaseDefinitionResponse"
        403:
          description: "Indicates the user does not have the rights to query for the\
            \ knowledge base definition."
        404:
          description: "Indicates the requested knowledge base definition was not\
            \ found."
      security:
      - basicAuth: []
  /agent-runtime/agent-instances:
    get:
      tags:
      - "Agent Instances"
      summary: "Query agent instances"
      description: ""
      operationId: "queryAgentInstances"
      produces:
      - "application/json"
      parameters:
      - name: "agentDefinitionId"
        in: "query"
        description: "Filter agent instances based on the agent definition id"
        required: false
        type: "string"
      - name: "agentDefinitionKey"
        in: "query"
        description: "Filter agent instances based on the agent definition key"
        required: false
        type: "string"
      - name: "id"
        in: "query"
        description: "Filter agent instances based on the agent instance id"
        required: false
        type: "string"
      - name: "order"
        in: "query"
        description: "From the paginate request.  The sort order, either 'asc' or\
          \ 'desc'. Defaults to 'asc'."
        required: false
        type: "string"
      - name: "referenceId"
        in: "query"
        description: "Filter agent instances based on the reference id"
        required: false
        type: "string"
      - name: "referenceType"
        in: "query"
        description: "Filter agent instances based on the reference type"
        required: false
        type: "string"
      - name: "size"
        in: "query"
        description: "From the paginate request. Number of rows to fetch, starting\
          \ from start. Defaults to 10."
        required: false
        type: "integer"
        format: "int32"
      - name: "sort"
        in: "query"
        description: "Property to sort the results on"
        required: false
        type: "string"
      - name: "start"
        in: "query"
        description: "From the paginate request. Index of the first row to fetch.\
          \ Defaults to 0."
        required: false
        type: "integer"
        format: "int32"
      - name: "startUserId"
        in: "query"
        description: "Filter agent instances started by the given user"
        required: false
        type: "string"
      - name: "tenantId"
        in: "query"
        description: "Filter agent instances based on the tenant id"
        required: false
        type: "string"
      - name: "tenantIdLike"
        in: "query"
        description: "Filter agent instances based on a tenant id like the given one"
        required: false
        type: "string"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/DataResponseAgentInstanceResponse"
        400:
          description: "Indicates the request had some invalid arguments."
      security:
      - basicAuth: []
    post:
      tags:
      - "Agent Instances"
      summary: "Start an agent instance"
      description: ""
      operationId: "startAgentInstance"
      produces:
      - "application/json"
      parameters:
      - in: "body"
        name: "body"
        required: false
        schema:
          $ref: "#/definitions/AgentInstanceCreateRequest"
      responses:
        201:
          description: "Indicates the agent instance was started."
          schema:
            $ref: "#/definitions/AgentInstanceResponse"
        400:
          description: "Indicates the agent instance could not be started due to some\
            \ invalid arguments."
        404:
          description: "Indicates the agent-definition was not found."
      security:
      - basicAuth: []
  /agent-runtime/agent-instances/{agentInstanceId}:
    get:
      tags:
      - "Agent Instances"
      summary: "Get agent instance details"
      description: ""
      operationId: "getAgentInstance"
      produces:
      - "application/json"
      parameters:
      - name: "agentInstanceId"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/AgentInstanceResponse"
        400:
          description: "Indicates the request had some invalid arguments."
        403:
          description: "Indicates that the user does not have access to the agent\
            \ instance."
        404:
          description: "Indicates that agent instance does not exist or the user does\
            \ not have access to it."
      security:
      - basicAuth: []
  /agent-runtime/agent-instances/{agentInstanceId}/exchanges:
    post:
      tags:
      - "Agent Instances"
      summary: "Continue the exchange with a running agent instance"
      description: ""
      operationId: "exchangeAgentInstance"
      produces:
      - "application/json"
      parameters:
      - name: "agentInstanceId"
        in: "path"
        required: true
        type: "string"
      - in: "body"
        name: "body"
        required: false
        schema:
          $ref: "#/definitions/AgentInstanceExchangeRequest"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/AgentInstanceResponse"
        400:
          description: "Indicates the request had some invalid arguments."
        403:
          description: "Indicates that the user does not have access to the agent\
            \ instance."
        404:
          description: "Indicates that agent instance does not exist or the user does\
            \ not have access to it."
      security:
      - basicAuth: []
  /agent-runtime/knowledge-base-items:
    get:
      tags:
      - "Knowledge Base  Items"
      summary: "Query knowledge base items"
      description: ""
      operationId: "queryKnowledgeBaseItems"
      produces:
      - "application/json"
      parameters:
      - name: "order"
        in: "query"
        description: "From the paginate request.  The sort order, either 'asc' or\
          \ 'desc'. Defaults to 'asc'."
        required: false
        type: "string"
      - name: "size"
        in: "query"
        description: "From the paginate request. Number of rows to fetch, starting\
          \ from start. Defaults to 10."
        required: false
        type: "integer"
        format: "int32"
      - name: "sort"
        in: "query"
        description: "Property to sort the results on"
        required: false
        type: "string"
      - name: "start"
        in: "query"
        description: "From the paginate request. Index of the first row to fetch.\
          \ Defaults to 0."
        required: false
        type: "integer"
        format: "int32"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/DataResponseKnowledgeBaseItemResponse"
        400:
          description: "Indicates the request had some invalid arguments."
      security:
      - basicAuth: []
  /agent-runtime/knowledge-base-items/{knowledgeBaseItemId}:
    get:
      tags:
      - "Agent Instances"
      summary: "Get agent instance details"
      description: ""
      operationId: "getKnowledgeBaseItem"
      produces:
      - "application/json"
      parameters:
      - name: "knowledgeBaseItemId"
        in: "path"
        required: true
        type: "string"
      responses:
        200:
          description: "Indicates the request was successful."
          schema:
            $ref: "#/definitions/KnowledgeBaseItemResponse"
        400:
          description: "Indicates the request had some invalid arguments."
        403:
          description: "Indicates that the user does not have access to the agent\
            \ instance."
        404:
          description: "Indicates that agent instance does not exist or the user does\
            \ not have access to it."
      security:
      - basicAuth: []
securityDefinitions:
  basicAuth:
    type: "basic"
definitions:
  AgentConnectionCreateRequest:
    type: "object"
    required:
    - "key"
    - "name"
    properties:
      key:
        type: "string"
        description: "Stable key the agent references"
      name:
        type: "string"
        description: "Human-readable display name"
      connectivity:
        type: "object"
        description: "Provider connectivity payload — polymorphic on aiVendor."
      tenantId:
        type: "string"
        description: "The tenant id of the Agent connection"
    description: "Request used to create a new Agent connection"
  AgentConnectionResponse:
    type: "object"
    required:
    - "key"
    properties:
      id:
        type: "string"
        description: "Internal id of the Agent connection"
      key:
        type: "string"
        description: "Stable key the agent references"
      name:
        type: "string"
        description: "Human-readable display name"
      connectivity:
        type: "object"
        description: "Provider connectivity payload (vendor-specific shape)."
      tenantId:
        type: "string"
        description: "Tenant the connection belongs to"
      updateTime:
        type: "integer"
        format: "int64"
        description: "When the connection was last updated"
      updaterId:
        type: "string"
        description: "User that last updated the connection"
    description: "REST representation of an AgentConnection."
  AgentConnectionUpdateRequest:
    type: "object"
    properties:
      name:
        type: "string"
        description: "Human-readable display name"
      connectivity:
        type: "object"
        description: "Provider connectivity payload — polymorphic on aiVendor."
    description: "Request used to update an Agent connection"
  AgentDefinitionResponse:
    type: "object"
    required:
    - "id"
    - "key"
    - "name"
    - "version"
    properties:
      id:
        type: "string"
        description: "The unique identifier of an agent definition"
      key:
        type: "string"
        description: "The key of the agent definition"
      name:
        type: "string"
        description: "The name of the agent definition"
      version:
        type: "integer"
        format: "int32"
        description: "The version of the agent definition"
      deploymentId:
        type: "string"
        description: "The deployment id of the agent definition"
      tenantId:
        type: "string"
        description: "The tenant id of the agent definition"
      resourceName:
        type: "string"
        description: "The resource name of the agent definition"
      description:
        type: "string"
        description: "The description of the agent definition"
      type:
        type: "string"
        description: "The type for the agent definition"
      apiEnabled:
        type: "boolean"
        description: "Whether the agent definition is enabled for API usage"
    description: "The response for an agent definition"
  AgentDeploymentResponse:
    type: "object"
    required:
    - "id"
    properties:
      id:
        type: "string"
        description: "The unique identifier of an agent deployment"
      name:
        type: "string"
        description: "The name of the agent deployment"
      deploymentTime:
        type: "string"
        description: "The deployment date in ISO 8601 for the action deployment)"
      category:
        type: "string"
        description: "The category of the agent deployment"
      parentDeploymentId:
        type: "string"
        description: "The parent deployment id of the agent deployment"
      tenantId:
        type: "string"
        description: "The tenant id of the agent deployment"
    description: "The response for an agent deployment"
  AgentExchangePartTimelineResponse:
    type: "object"
    required:
    - "id"
    - "type"
    properties:
      id:
        type: "string"
        example: "part-1"
        description: "The unique identifier of the exchange part"
      type:
        type: "string"
        example: "input"
        description: "The type of the part"
        enum:
        - "input"
        - "output"
        - "toolInput"
        - "toolOutput"
      subType:
        type: "string"
        example: "request"
        description: "The sub-type providing additional context based on the type"
        enum:
        - "request"
        - "response"
        - "technical"
        - "system"
        - "toolCall"
        - "arguments"
      content:
        type: "string"
        example: "What is the weather today?"
        description: "The content of the part, which can be a string or JSON object\
          \ depending on the type"
      invocationSequence:
        type: "integer"
        format: "int32"
        example: 1
        description: "The sequence number of this part within the invocation"
    description: "Represents a single part of an exchange containing specific content"
  AgentExchangeTimelineResponse:
    type: "object"
    required:
    - "id"
    - "subType"
    - "type"
    properties:
      id:
        type: "string"
        example: "exchange-1"
        description: "The unique identifier of the exchange"
      startTime:
        type: "integer"
        format: "int64"
        example: "2025-10-15T10:30:00Z"
        description: "The time when the exchange started"
      endTime:
        type: "integer"
        format: "int64"
        example: "2025-10-15T10:30:02Z"
        description: "The time when the exchange ended"
      duration:
        example: "PT2S"
        description: "The duration of the exchange in ISO-8601 format"
        $ref: "#/definitions/Duration"
      type:
        type: "string"
        example: "user"
        description: "The type of the exchange"
        enum:
        - "user"
        - "assistant"
        - "tool"
        - "chatModel"
      subType:
        type: "string"
        example: "gpt-4.1-2025-04-14"
        description: "The sub-type providing additional context based on the type\
          \ (e.g., tool name, model name)"
      userId:
        type: "string"
        example: "admin"
        description: "The ID of the user who initiated the exchange"
      promptTokenCount:
        type: "integer"
        format: "int32"
        example: 50
        description: "The number of prompt tokens consumed during this exchange"
      outputTokenCount:
        type: "integer"
        format: "int32"
        example: 25
        description: "The number of output tokens generated during this exchange"
      transactionOrder:
        type: "integer"
        format: "int32"
        example: 0
        description: "The sequence number of this exchange within the invocation"
      parts:
        type: "array"
        description: "List of all parts that make up this exchange"
        items:
          $ref: "#/definitions/AgentExchangePartTimelineResponse"
    description: "Represents a single exchange in an agent invocation (user, assistant,\
      \ tool, or chatModel interaction)"
  AgentInstanceCreateRequest:
    type: "object"
    properties:
      agentDefinitionId:
        type: "string"
        description: "The id of the definition for starting the agent instance"
      agentDefinitionKey:
        type: "string"
        description: "The key of the definition for starting the agent instance"
      tenantId:
        type: "string"
        description: "The tenant id of the definition for starting the agent instance"
      operationKey:
        type: "string"
        description: "The operation key to execute from the agent"
      overrideDefinitionTenantId:
        type: "string"
        description: "The tenant id that should be used for the agent instance"
      payload:
        type: "array"
        description: "Payload variables passed to the agent when starting a new instance"
        items:
          $ref: "#/definitions/EngineRestVariable"
  AgentInstanceExchangeRequest:
    type: "object"
    properties:
      operationKey:
        type: "string"
        description: "The operation key to execute from the agent"
      payload:
        type: "array"
        description: "Payload variables passed to the agent when starting a new instance"
        items:
          $ref: "#/definitions/EngineRestVariable"
  AgentInstanceResponse:
    type: "object"
    required:
    - "agentDefinitionId"
    - "agentDefinitionKey"
    - "agentDefinitionName"
    - "id"
    - "startTime"
    properties:
      id:
        type: "string"
        description: "The unique identifier of an agent instance"
      agentDefinitionId:
        type: "string"
        description: "The id of the agent definition that was used to start the agent\
          \ instance."
      agentDefinitionKey:
        type: "string"
        description: "The key of the agent definition that was used to start the agent\
          \ instance."
      agentDefinitionName:
        type: "string"
        description: "The name of the agent definition that was used to start the\
          \ agent instance."
      referenceId:
        type: "string"
        description: "The id of the CMMN or BPMN model backing the agent instance\
          \ behavior."
      referenceType:
        type: "string"
        description: "The type of the model that backs the agent instance behavior\
          \ (e.g. CMMN or BPMN)."
      callbackId:
        type: "string"
        description: "The id of the CMMN or BPMN instance that should be called back\
          \ when the agent is done."
      callbackType:
        type: "string"
        description: "The type of the callback (e.g. CMMN or BPMN)."
      callbackScopeId:
        type: "string"
        description: "The callback scope id for this agent instance."
      startTime:
        type: "integer"
        format: "int64"
        description: "The time the instance was started."
      startUserId:
        type: "string"
        description: "The user that started the agent instance."
      tenantId:
        type: "string"
        description: "The tenant id of the instance"
      jsonInvocationResult:
        $ref: "#/definitions/JsonNode"
      plainTextInvocationResult:
        type: "string"
      durationMs:
        type: "integer"
        format: "int64"
        description: "Wall-clock duration of the invocation in milliseconds."
      promptTokenCount:
        type: "integer"
        format: "int64"
        description: "Aggregated prompt tokens used by the invocation."
      outputTokenCount:
        type: "integer"
        format: "int64"
        description: "Aggregated output tokens produced by the invocation."
      executionTrace:
        description: "In-memory trace of the invocation, populated for direct model\
          \ invocation without persistence."
        $ref: "#/definitions/AgentInstanceTimelineResponse"
    description: "The response for an agent instance"
  AgentInstanceTimelineResponse:
    type: "object"
    required:
    - "definitionId"
    - "id"
    properties:
      id:
        type: "string"
        example: "agent-instance-1"
        description: "The unique identifier of the agent instance"
      definitionId:
        type: "string"
        example: "agent-definition-1"
        description: "The ID of the agent definition that was used to start this instance"
      definitionName:
        type: "string"
        example: "Customer Support Agent"
        description: "The name of the agent definition"
      definitionKey:
        type: "string"
        example: "customerSupportAgent"
        description: "The key of the agent definition"
      invocations:
        type: "array"
        description: "List of all invocations that occurred within this agent instance"
        items:
          $ref: "#/definitions/AgentInvocationTimelineResponse"
    description: "Complete timeline view of an agent instance with all its invocations,\
      \ exchanges and parts"
  AgentInvocationEvaluationResponse:
    type: "object"
    required:
    - "agentInstanceId"
    - "id"
    - "invocationId"
    properties:
      id:
        type: "string"
        description: "The unique identifier for the agent invocation evaluation."
      invocationId:
        type: "string"
        description: "The identifier for the correlating agent invocation."
      agentInstanceId:
        type: "string"
        description: "The identifier for the correlating agent instance."
      operationKey:
        type: "string"
        description: "The key of the operation that the evaluation belongs to."
      evaluatorKey:
        type: "string"
        description: "The stable identity for the evaluator across runs."
      evaluatorSubKey:
        type: "string"
        description: "The operation scored by an agent/service evaluator; null for\
          \ the expression kind."
      kind:
        type: "string"
        description: "The kind of the evaluation (agent, delegateExpression, service)."
      passed:
        type: "boolean"
        description: "The verdict of the evaluation. Null until the evaluation completes\
          \ (its endTime is set)."
      score:
        type: "number"
        format: "double"
        description: "The score returned by the evaluator."
      scoreMin:
        type: "number"
        format: "double"
        description: "The lower bound of the score range."
      scoreMax:
        type: "number"
        format: "double"
        description: "The upper bound of the score range."
      reason:
        type: "string"
        description: "The reason returned by the evaluator."
      referenceScopeId:
        type: "string"
        description: "Drill-down handle to the scope that produced the verdict (the\
          \ judge agent instance for the agent kind)."
      referenceScopeType:
        type: "string"
        description: "Scope type of referenceScopeId (agent for the agent kind; null\
          \ otherwise)."
      startTime:
        type: "integer"
        format: "int64"
        description: "The time when the evaluation was started."
      endTime:
        type: "integer"
        format: "int64"
        description: "The time when the evaluation ended."
      durationInMillis:
        type: "integer"
        format: "int64"
        description: "The duration of the evaluation in milliseconds."
    description: "Response for an agent invocation evaluation"
  AgentInvocationExchangePartResponse:
    type: "object"
    required:
    - "exchangeId"
    - "id"
    properties:
      id:
        type: "string"
        description: "The unique identifier for the agent invocation exchange part."
      exchangeId:
        type: "string"
        description: "The identifier for the correlating agent invocation exchange."
      type:
        type: "string"
        description: "The type of the exchange part"
      subType:
        type: "string"
        description: "The sub type of the exchange part"
      content:
        type: "string"
        description: "The content of the exchange part"
      invocationSequence:
        type: "integer"
        format: "int64"
        description: "The order of the part in the exchange"
    description: "Response for an agent invocation exchange part"
  AgentInvocationExchangeResponse:
    type: "object"
    required:
    - "agentInstanceId"
    - "creationTime"
    - "id"
    - "invocationId"
    properties:
      id:
        type: "string"
        description: "The unique identifier for the agent invocation exchange."
      agentInstanceId:
        type: "string"
        description: "The identifier for the correlating agent instance."
      invocationId:
        type: "string"
        description: "The identifier for the correlating agent invocation."
      agentDefinitionId:
        type: "string"
        description: "The identifier for the agent definition."
      agentDefinitionKey:
        type: "string"
        description: "The key of the agent definition."
      creationTime:
        type: "integer"
        format: "int64"
        description: "The time when the exchange was created"
      endTime:
        type: "integer"
        format: "int64"
        description: "The time when the exchange ended"
      duration:
        description: "The duration of the exchange"
        $ref: "#/definitions/Duration"
      type:
        type: "string"
        description: "The type of the exchange"
      subType:
        type: "string"
        description: "The sub type of the exchange"
      userId:
        type: "string"
        description: "The id of the user that triggered the exchange"
      promptTokenCount:
        type: "integer"
        format: "int64"
        description: "The amount of tokens used for the prompt"
      outputTokenCount:
        type: "integer"
        format: "int64"
        description: "The amount of tokens used for the output"
      cachedTokenCount:
        type: "integer"
        format: "int64"
        description: "The amount of cached tokens used for the prompt"
    description: "Response for an agent invocation exchange"
  AgentInvocationResponse:
    type: "object"
    required:
    - "agentInstanceId"
    - "id"
    - "operationKey"
    - "startTime"
    properties:
      id:
        type: "string"
        description: "The unique identifier for the agent invocation."
      agentInstanceId:
        type: "string"
        description: "The identifier for the correlating agent instance."
      agentDefinitionId:
        type: "string"
        description: "The identifier for the agent definition."
      agentDefinitionKey:
        type: "string"
        description: "The key of the agent definition."
      operationKey:
        type: "string"
        description: "The key of the operation that the invocation belongs to"
      startTime:
        type: "integer"
        format: "int64"
        description: "The time when the invocation was started"
      endTime:
        type: "integer"
        format: "int64"
        description: "The time when the invocation was ended"
      duration:
        description: "The duration of the invocation"
        $ref: "#/definitions/Duration"
      userId:
        type: "string"
        description: "The id of the user that triggered the invocation"
      promptTokenCount:
        type: "integer"
        format: "int64"
        description: "The amount of tokens used for the prompt"
      outputTokenCount:
        type: "integer"
        format: "int64"
        description: "The amount of tokens used for the output"
      cachedTokenCount:
        type: "integer"
        format: "int64"
        description: "The amount of cached tokens used for the prompt"
    description: "Response for an agent invocation"
  AgentInvocationTimelineResponse:
    type: "object"
    required:
    - "id"
    properties:
      id:
        type: "string"
        example: "invoc-1"
        description: "The unique identifier of the invocation"
      startTime:
        type: "integer"
        format: "int64"
        example: "2025-10-15T10:30:00Z"
        description: "The time when the invocation started"
      endTime:
        type: "integer"
        format: "int64"
        example: "2025-10-15T10:30:05Z"
        description: "The time when the invocation ended"
      operationKey:
        type: "string"
        example: "processUserRequest"
        description: "The key of the operation that was invoked"
      promptTokenCount:
        type: "integer"
        format: "int32"
        example: 150
        description: "The number of prompt tokens consumed during this invocation"
      outputTokenCount:
        type: "integer"
        format: "int32"
        example: 75
        description: "The number of output tokens generated during this invocation"
      exchanges:
        type: "array"
        description: "List of all exchanges that occurred during this invocation"
        items:
          $ref: "#/definitions/AgentExchangeTimelineResponse"
    description: "Represents a single agent invocation with its exchanges and token\
      \ usage"
  AgentModelPriceRequest:
    type: "object"
    properties:
      modelPrefix:
        type: "string"
      inputPrice:
        type: "number"
      outputPrice:
        type: "number"
      cachedPrice:
        type: "number"
  AgentModelPriceResponse:
    type: "object"
    properties:
      modelPrefix:
        type: "string"
      inputPrice:
        type: "number"
      outputPrice:
        type: "number"
      cachedPrice:
        type: "number"
  BulkMoveDeadLetterActionRequest:
    type: "object"
    properties:
      action:
        type: "string"
      jobIds:
        type: "array"
        items:
          type: "string"
  DataResponse:
    type: "object"
    properties:
      data:
        type: "array"
        items:
          type: "object"
      total:
        type: "integer"
        format: "int64"
      start:
        type: "integer"
        format: "int32"
      sort:
        type: "string"
      order:
        type: "string"
      size:
        type: "integer"
        format: "int32"
  DataResponseAgentConnectionResponse:
    type: "object"
    properties:
      data:
        type: "array"
        items:
          $ref: "#/definitions/AgentConnectionResponse"
      total:
        type: "integer"
        format: "int64"
      start:
        type: "integer"
        format: "int32"
      sort:
        type: "string"
      order:
        type: "string"
      size:
        type: "integer"
        format: "int32"
  DataResponseAgentDefinitionResponse:
    type: "object"
    properties:
      data:
        type: "array"
        items:
          $ref: "#/definitions/AgentDefinitionResponse"
      total:
        type: "integer"
        format: "int64"
      start:
        type: "integer"
        format: "int32"
      sort:
        type: "string"
      order:
        type: "string"
      size:
        type: "integer"
        format: "int32"
  DataResponseAgentDeploymentResponse:
    type: "object"
    properties:
      data:
        type: "array"
        items:
          $ref: "#/definitions/AgentDeploymentResponse"
      total:
        type: "integer"
        format: "int64"
      start:
        type: "integer"
        format: "int32"
      sort:
        type: "string"
      order:
        type: "string"
      size:
        type: "integer"
        format: "int32"
  DataResponseAgentInstanceResponse:
    type: "object"
    properties:
      data:
        type: "array"
        items:
          $ref: "#/definitions/AgentInstanceResponse"
      total:
        type: "integer"
        format: "int64"
      start:
        type: "integer"
        format: "int32"
      sort:
        type: "string"
      order:
        type: "string"
      size:
        type: "integer"
        format: "int32"
  DataResponseAgentInvocationEvaluationResponse:
    type: "object"
    properties:
      data:
        type: "array"
        items:
          $ref: "#/definitions/AgentInvocationEvaluationResponse"
      total:
        type: "integer"
        format: "int64"
      start:
        type: "integer"
        format: "int32"
      sort:
        type: "string"
      order:
        type: "string"
      size:
        type: "integer"
        format: "int32"
  DataResponseAgentInvocationExchangeResponse:
    type: "object"
    properties:
      data:
        type: "array"
        items:
          $ref: "#/definitions/AgentInvocationExchangeResponse"
      total:
        type: "integer"
        format: "int64"
      start:
        type: "integer"
        format: "int32"
      sort:
        type: "string"
      order:
        type: "string"
      size:
        type: "integer"
        format: "int32"
  DataResponseAgentInvocationResponse:
    type: "object"
    properties:
      data:
        type: "array"
        items:
          $ref: "#/definitions/AgentInvocationResponse"
      total:
        type: "integer"
        format: "int64"
      start:
        type: "integer"
        format: "int32"
      sort:
        type: "string"
      order:
        type: "string"
      size:
        type: "integer"
        format: "int32"
  DataResponseHistoricAgentInstanceKnowledgeBaseLinkResponse:
    type: "object"
    properties:
      data:
        type: "array"
        items:
          $ref: "#/definitions/HistoricAgentInstanceKnowledgeBaseLinkResponse"
      total:
        type: "integer"
        format: "int64"
      start:
        type: "integer"
        format: "int32"
      sort:
        type: "string"
      order:
        type: "string"
      size:
        type: "integer"
        format: "int32"
  DataResponseHistoricAgentInstanceResponse:
    type: "object"
    properties:
      data:
        type: "array"
        items:
          $ref: "#/definitions/HistoricAgentInstanceResponse"
      total:
        type: "integer"
        format: "int64"
      start:
        type: "integer"
        format: "int32"
      sort:
        type: "string"
      order:
        type: "string"
      size:
        type: "integer"
        format: "int32"
  DataResponseJobResponse:
    type: "object"
    properties:
      data:
        type: "array"
        items:
          $ref: "#/definitions/JobResponse"
      total:
        type: "integer"
        format: "int64"
      start:
        type: "integer"
        format: "int32"
      sort:
        type: "string"
      order:
        type: "string"
      size:
        type: "integer"
        format: "int32"
  DataResponseKnowledgeBaseDefinitionResponse:
    type: "object"
    properties:
      data:
        type: "array"
        items:
          $ref: "#/definitions/KnowledgeBaseDefinitionResponse"
      total:
        type: "integer"
        format: "int64"
      start:
        type: "integer"
        format: "int32"
      sort:
        type: "string"
      order:
        type: "string"
      size:
        type: "integer"
        format: "int32"
  DataResponseKnowledgeBaseItemResponse:
    type: "object"
    properties:
      data:
        type: "array"
        items:
          $ref: "#/definitions/KnowledgeBaseItemResponse"
      total:
        type: "integer"
        format: "int64"
      start:
        type: "integer"
        format: "int32"
      sort:
        type: "string"
      order:
        type: "string"
      size:
        type: "integer"
        format: "int32"
  Duration:
    type: "object"
    properties:
      seconds:
        type: "integer"
        format: "int64"
      zero:
        type: "boolean"
      nano:
        type: "integer"
        format: "int32"
      negative:
        type: "boolean"
      positive:
        type: "boolean"
      units:
        type: "array"
        items:
          $ref: "#/definitions/TemporalUnit"
  EngineRestVariable:
    type: "object"
    properties:
      name:
        type: "string"
        example: "myVariable"
        description: "Name of the variable"
      type:
        type: "string"
        example: "string"
        description: "Type of the variable."
      value:
        type: "object"
        example: "test"
        description: "Value of the variable."
      valueUrl:
        type: "string"
        example: "http://...."
  HistoricAgentInstanceKnowledgeBaseLinkResponse:
    type: "object"
    required:
    - "externalId"
    - "historicAgentInstanceId"
    - "id"
    - "score"
    properties:
      id:
        type: "string"
        description: "The unique identifier for the action instance knowledge base\
          \ link response."
      historicAgentInstanceId:
        type: "string"
        description: "The identifier of the correlating historic agent instance."
      knowledgeBaseItemId:
        type: "string"
        description: "The identifier of the knowledge base item section."
      knowledgeBaseItemSectionId:
        type: "string"
        description: "The identifier of the knowledge base item section id."
      externalId:
        type: "string"
        description: "The external identifier of the document."
      score:
        type: "number"
        format: "double"
        description: "The score how this knowledge base link item matched"
    description: "Response for a historic action knowledge base link instance"
  HistoricAgentInstanceResponse:
    type: "object"
    required:
    - "agentDefinitionId"
    - "agentDefinitionKey"
    - "agentDefinitionName"
    - "endTime"
    - "id"
    - "startTime"
    properties:
      id:
        type: "string"
        description: "The unique identifier of a historic agent instance"
      agentDefinitionId:
        type: "string"
        description: "The id of the agent definition that was used to start the historic\
          \ agent instance."
      agentDefinitionKey:
        type: "string"
        description: "The key of the agent definition that was used to start the historic\
          \ agent instance."
      agentDefinitionName:
        type: "string"
        description: "The name of the agent definition that was used to start the\
          \ historic agent instance."
      referenceId:
        type: "string"
        description: "The id of the CMMN or BPMN model backing the historic agent\
          \ instance behavior."
      referenceType:
        type: "string"
        description: "The type of the model that backs the historic agent instance\
          \ behavior (e.g. CMMN or BPMN)."
      callbackId:
        type: "string"
        description: "The callback identifier for this agent instance."
      callbackType:
        type: "string"
        description: "The callback type for this agent instance."
      callbackScopeId:
        type: "string"
        description: "The callback scope id for this agent instance."
      state:
        type: "string"
        description: "The current state of this agent instance."
      startTime:
        type: "integer"
        format: "int64"
        description: "The time the instance was started."
      endTime:
        type: "integer"
        format: "int64"
        description: "The time the instance was ended."
      startUserId:
        type: "string"
        description: "The user that started the agent instance."
      jsonInvocationResult:
        $ref: "#/definitions/JsonNode"
      plainTextInvocationResult:
        type: "string"
    description: "The response for a historic agent instance"
  JobResponse:
    type: "object"
    properties:
      id:
        type: "string"
        example: "8"
      url:
        type: "string"
        example: "http://localhost:8182/management/jobs/8"
      elementId:
        type: "string"
        example: "scriptTask1"
      elementName:
        type: "string"
        example: "Script task"
      scopeId:
        type: "string"
      subScopeId:
        type: "string"
      scopeDefinitionId:
        type: "string"
      scopeType:
        type: "string"
      handlerType:
        type: "string"
        example: "cmmn-trigger-timer"
      retries:
        type: "integer"
        format: "int32"
        example: 3
      exceptionMessage:
        type: "string"
        example: "null"
      dueDate:
        type: "string"
        format: "date-time"
        example: "2023-06-04T22:05:05.474+0000"
      createTime:
        type: "string"
        format: "date-time"
        example: "2023-06-03T22:05:05.474+0000"
      lockOwner:
        type: "string"
        example: "node1"
      lockExpirationTime:
        type: "string"
        format: "date-time"
        example: "2023-06-03T22:05:05.474+0000"
      tenantId:
        type: "string"
        example: "null"
  JsonNode:
    type: "object"
    properties:
      string:
        type: "boolean"
      valueNode:
        type: "boolean"
      missingNode:
        type: "boolean"
      short:
        type: "boolean"
      double:
        type: "boolean"
      bigDecimal:
        type: "boolean"
      bigInteger:
        type: "boolean"
      textual:
        type: "boolean"
      boolean:
        type: "boolean"
      container:
        type: "boolean"
      object:
        type: "boolean"
      binary:
        type: "boolean"
      number:
        type: "boolean"
      nodeType:
        type: "string"
        enum:
        - "ARRAY"
        - "BINARY"
        - "BOOLEAN"
        - "MISSING"
        - "NULL"
        - "NUMBER"
        - "OBJECT"
        - "POJO"
        - "STRING"
      long:
        type: "boolean"
      pojo:
        type: "boolean"
      int:
        type: "boolean"
      integralNumber:
        type: "boolean"
      floatingPointNumber:
        type: "boolean"
      array:
        type: "boolean"
      empty:
        type: "boolean"
      null:
        type: "boolean"
      float:
        type: "boolean"
      embeddedValue:
        type: "boolean"
  KnowledgeBaseDefinitionResponse:
    type: "object"
    required:
    - "id"
    - "key"
    - "name"
    - "version"
    properties:
      id:
        type: "string"
        description: "The unique identifier of an knowledge base definition"
      key:
        type: "string"
        description: "The key of the knowledge base definition"
      name:
        type: "string"
        description: "The name of the knowledge base definition"
      version:
        type: "integer"
        format: "int32"
        description: "The version of the knowledge base definition"
      deploymentId:
        type: "string"
        description: "The deployment id of the knowledge base definition"
      tenantId:
        type: "string"
        description: "The tenant id of the knowledge base definition"
      resourceName:
        type: "string"
        description: "The resource name of the knowledge base definition"
      description:
        type: "string"
        description: "The description of the knowledge base definition"
      ready:
        type: "boolean"
        description: "If the specific knowledge base is ready for querying"
    description: "The response for a knowledge base definition"
  KnowledgeBaseItemResponse:
    type: "object"
    required:
    - "id"
    - "knowledgeBaseDefinitionId"
    - "knowledgeBaseDefinitionName"
    - "scopeId"
    - "scopeType"
    - "tenantId"
    properties:
      id:
        type: "string"
        description: "The unique identifier of a knowledge base item"
      parentId:
        type: "string"
        description: "The parent identifier of a knowledge base item"
      rootId:
        type: "string"
        description: "The root identifier of a knowledge base item"
      knowledgeBaseDefinitionId:
        type: "string"
        description: "The knowledge base definition id of a item"
      knowledgeBaseDefinitionName:
        type: "string"
        description: "The knowledge base definition name of a item"
      scopeId:
        type: "string"
        description: "The scope id of the knowledge base item"
      scopeType:
        type: "string"
        description: "The scope type of a knowledge base item"
      tenantId:
        type: "string"
        description: "The tenant id of a knowledge base item"
      container:
        type: "boolean"
    description: "The response for a knowledge base item"
  RestActionRequest:
    type: "object"
    properties:
      action:
        type: "string"
  TemporalUnit:
    type: "object"
    properties:
      durationEstimated:
        type: "boolean"
      duration:
        $ref: "#/definitions/Duration"
      timeBased:
        type: "boolean"
      dateBased:
        type: "boolean"
  TimerJobActionRequest:
    type: "object"
    properties:
      action:
        type: "string"
      dueDate:
        type: "string"