openapi: 3.1.0 info: title: Intuned Client version: 0.0.2 description: Programmatically trigger automations, manage Jobs, and handle AuthSessions. termsOfService: https://intuned.ai/terms contact: email: founders@intunedhq.com externalDocs: description: Find out more about Intuned url: https://intunedhq.com/docs/ security: - api_key: [] servers: - url: https://app.intuned.io/api/v1/workspace description: Base URL for Intuned API. tags: - name: projects.jobs description: Project Jobs API - name: projects.jobs.runs description: Project JobRuns API - name: projects.runs description: Run APIs - name: projects.authSessions description: Manage AuthSessions - name: projects.authSessions.validate description: Validate AuthSession - name: projects.authSessions.create description: Create AuthSession - name: projects.authSessions.update description: Update AuthSession - name: webTasks description: Web Tasks API - name: agent description: Autonomous Intuned Agent sessions components: securitySchemes: api_key: type: apiKey description: >- API Key used to authenticate your requests. [How to create one](/main/03-how-to/manage/manage-api-keys). in: header name: x-api-key schemas: WorkspaceId: type: string format: uuid ProjectName: type: string JobId: type: string JobRunId: type: string RunId: type: string AuthSessionId: type: string OperationId: type: string WebTaskId: type: string AgentSessionId: type: string parameters: WorkspaceId: schema: $ref: '#/components/schemas/WorkspaceId' required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true ProjectName: schema: $ref: '#/components/schemas/ProjectName' required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName JobId: schema: $ref: '#/components/schemas/JobId' required: true description: The ID you assigned when creating the Job. example: my-sample-job in: path name: jobId JobRunId: schema: $ref: '#/components/schemas/JobRunId' required: true description: >- The JobRun ID. Get this from the list JobRuns endpoint or from the trigger Job response. example: jr_abc123def456ghi789xyz in: path name: jobRunId RunId: schema: format: nanoid type: string required: true description: Run ID example: aabbccddeeffggh in: path name: runId AuthSessionId: schema: $ref: '#/components/schemas/AuthSessionId' required: true description: >- Authentication session ID. You can obtain it from the AuthSessions tab in your project details. in: path name: authSessionId OperationId: schema: $ref: '#/components/schemas/OperationId' required: true description: The ID for the operation. This is obtained from the start request. example: aaaabbbCCCCdddd in: path name: operationId WebTaskId: schema: $ref: '#/components/schemas/WebTaskId' required: true description: Web Task ID. Returned from the start endpoint as `webTaskId`. example: wt_123 in: path name: webTaskId AgentSessionId: schema: $ref: '#/components/schemas/AgentSessionId' required: true description: Agent session ID. Returned from the start endpoint as `id`. example: b3f1c2e4-1234-5678-9abc-def012345678 in: path name: id paths: /{workspaceId}/projects/{projectName}/run/start: post: tags: - projects.runs summary: Run API - Start description: Start a Run for a Project. operationId: runApiStart x-speakeasy-name-override: start parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName x-codeSamples: - lang: typescript label: runApiStart source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.runs.start( "my-project", { parameters: { "param1": "value1", "param2": 42, "param3": true }, api: "value", }, ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient from intuned_client import models import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.runs.start( project_name="my-project", body=models.RunStartRequestBody( parameters={ "param1": "value1", "param2": 42, "param3": True, }, api="my-awesome-api", proxy="http://username:password@domain:port", saveTrace=True, requestTimeout=600, ), ) print(res) requestBody: description: Run API input schema required: true content: application/json: schema: type: object properties: parameters: type: object additionalProperties: true description: The parameters to be passed to the API. example: param1: value1 param2: 42 param3: true proxy: type: - string - 'null' format: uri description: >- Proxy URL to be used for the API call. This is optional and can be used to route the API call through a proxy server. Use "intuned://auto" to let the platform pick a proxy for this project. example: http://username:password@domain:port saveTrace: type: boolean requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 retry: type: object properties: maximumAttempts: type: integer minimum: 1 default: 3 description: >- Maximum number of attempts to retry the run in case of failure example: 3 default: maximumAttempts: 3 description: Retry policy configurations in case of failure. example: maximumAttempts: 3 authSession: anyOf: - type: object properties: id: type: string autoRecreate: type: boolean enum: - true default: true checkAttempts: type: integer default: 3 description: >- Number of attempts to check the validity of the AuthSession before recreating it. example: 3 createAttempts: type: integer default: 3 description: >- Number of attempts to create a new AuthSession if the current one is invalid or expired. example: 3 proxy: type: - string - 'null' format: uri description: >- Proxy URL to be used for the API call. This is optional and can be used to route the API call through a proxy server. Use "intuned://auto" to let the platform pick a proxy for this project. example: http://username:password@domain:port requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 saveTrace: type: boolean description: >- Whether trace files should be saved for auth session runs (validate, create, update) triggered by this API run. Defaults to the API request's saveTrace value. Project-level defaults.authSession.saveTrace overrides this. example: true runtimeInput: type: object additionalProperties: true description: >- Runtime input to be used for the AuthSession. This is optional and can be used to pass dynamic values at runtime. example: username: user password: pass required: - runtimeInput description: >- Runtime based AuthSession config to be used with the run. This is a required field if the AuthSession is enabled on the project and uses runtime input. title: Runtime Based AuthSession Input - type: object properties: id: type: string description: The ID of the AuthSession to use. example: auth-session-123 autoRecreate: type: boolean default: true description: >- If true, the AuthSession will be automatically recreated if it is invalid or expired. example: true checkAttempts: type: integer default: 3 description: >- Number of attempts to check the validity of the AuthSession before recreating it. example: 3 createAttempts: type: integer default: 3 description: >- Number of attempts to create a new AuthSession if the current one is invalid or expired. example: 3 proxy: type: - string - 'null' format: uri description: >- Proxy URL to be used for the API call. This is optional and can be used to route the API call through a proxy server. Use "intuned://auto" to let the platform pick a proxy for this project. example: http://username:password@domain:port requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 saveTrace: type: boolean description: >- Whether trace files should be saved for auth session runs (validate, create, update) triggered by this API run. Defaults to the API request's saveTrace value. Project-level defaults.authSession.saveTrace overrides this. example: true required: - id description: >- Credentials based AuthSession config to be used with the run. This is a required field if the AuthSession is enabled on the project and uses credentials. title: Credentials Based AuthSession Input description: >- AuthSession config to be used with the run. This is a required field if the AuthSession is enabled on the project. sink: oneOf: - type: object properties: type: type: string enum: - webhook url: type: string description: The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token skipOnFail: type: boolean default: false description: >- If true, the webhook will not be sent if the API execution fails. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the webhook. If not provided, all APIs will be sent. example: - api1 - api2 required: - type - url description: Configuration for the webhook sink. title: Webhook Sink Configuration - type: object properties: type: type: string enum: - s3 bucket: type: string description: >- The name of the S3 bucket where the data will be stored. example: my-s3-bucket accessKeyId: type: string description: The access key ID for the S3 bucket. example: AKIAIOSFODNN7EXSSPLE secretAccessKey: type: string description: The secret access key for the S3 bucket. example: wJalrXUtnFFFI/K7MDENG/bPxRfiCYEXAMPLEKEY region: type: string description: The region where the S3 bucket is located. example: us-west-2 prefix: type: string description: >- Optional prefix for the S3 objects. This can be used to organize objects within the bucket. example: my-prefix/ skipOnFail: type: boolean default: false description: >- If enabled, failed payload runs will ***not*** be written to the bucket. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the S3 bucket. If not provided, all APIs will be sent. example: - api1 - api2 endpoint: type: string description: >- Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services. example: https://s3.custom-endpoint.com forcePathStyle: type: boolean description: >- If true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access. example: true required: - type - bucket - accessKeyId - secretAccessKey - region description: Configuration for the S3 sink. title: S3 Sink Configuration description: >- Optional sink configuration for the run. Can be a webhook or S3 sink. api: type: string description: >- The name of the API to be executed. This is the file path relative to the `api` folder inside your project. required: - parameters - api example: api: my-awesome-api parameters: param1: value1 param2: 42 param3: true retry: maximumAttempts: 3 responses: '201': description: Run started successfully. content: application/json: schema: type: object properties: runId: type: string description: Unique identifier for the run, prefixed nanoId (ru_...) status: type: string enum: - pending required: - runId - status /{workspaceId}/projects/{projectName}/run/{runId}/result: get: tags: - projects.runs summary: Run API - Result description: Get Run result. operationId: runApiResult x-speakeasy-name-override: result parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: format: nanoid type: string required: true description: Run ID example: aabbccddeeffggh in: path name: runId x-codeSamples: - lang: typescript label: runApiResult source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.runs.result( "my-project", "aabbccddeeffggh", ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.runs.result( project_name="my-project", run_id="aabbccddeeffggh", ) print(res) responses: '200': description: Run result with status and output data. content: application/json: schema: type: object properties: runId: type: string description: Unique identifier for the run, prefixed nanoId (ru_...) status: type: string enum: - pending - started - completed - canceled - failed description: Status of the run execution example: completed result: description: Output result of the run execution extendedPayloads: type: array items: type: object properties: api: type: string description: >- The name of the API to be executed. This is the file path relative to the `api` folder inside your project. runId: type: string parameters: type: object additionalProperties: true description: The parameters to be passed to the API. example: param1: value1 param2: 42 param3: true required: - api description: Extended payloads from the run execution error: type: object properties: message: type: string description: Error message describing the failure example: An error occurred while executing the run code: type: string enum: - internal-server-error - script-process-crashed - unexpected - script-process-crashed - script-execution-exception - script-no-valid-output-received - result-too-big-error - script-timeout - script-unexpected-error - auth-check-failed - all-attempts-failed - check-attempts-failed - create-attempts-failed - post-create-check-attempts-failed - api-attempts-failed - onepassword-integration-error - job-run-terminated description: >- Optional error code for more specific error identification example: script-process-crashed category: type: string enum: - infrastructure - execution - auth - user - billing retirable: type: boolean default: false doc_url: type: string description: Optional URL to documentation for this error example: >- https://intunedhq.com/docs/main/support/errors#run-execution-error correlation_id: type: string description: Optional correlation ID for tracing the error in logs example: 123e4567-e89b-12d3-a456-426614174000 details: {} required: - message - category message: type: string description: Error or reason message reason: type: object properties: type: type: string enum: - auth-session-validate-dependency-failed - terminated - job-run-paused - job-run-terminated - failed-to-initialize-job-run - api-access-disabled - cancelled-user-action message: type: string doc_url: type: string description: Optional URL to documentation for this error example: >- https://intunedhq.com/docs/main/support/reasons#terminated details: {} required: - type - message required: - runId - status examples: completed: value: runId: '123' status: completed result: key1: value1 key2: 42 extendedPayloads: - api: my-awesome-api runId: '123' parameters: param1: value1 param2: 42 failed: value: runId: '123' status: failed error: code: all-attempts-failed message: All attempts to run the integration have failed. pending: value: runId: '123' status: pending /{workspaceId}/projects/{projectName}/jobs: get: tags: - projects.jobs summary: Get Jobs description: Get all Jobs in a Project. operationId: getJobs x-speakeasy-name-override: all parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName x-codeSamples: - lang: typescript label: getJobs source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.jobs.all("my-project"); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.jobs.list( project_name="my-project", ) print(res) responses: '200': description: List of jobs in the project. content: application/json: schema: type: array items: type: object properties: id: type: string minLength: 1 pattern: ^[a-zA-Z0-9\-_]+$ description: The ID of the job. Has to be a valid URL slug. example: 123e4567-e89b-12d3-a456-426614174000 workspace_id: type: string format: uuid description: UUID of the workspace this job belongs to example: 123e4567-e89b-12d3-a456-426614174000 project_id: type: string format: uuid description: UUID of the project this job belongs to example: 123e4567-e89b-12d3-a456-426614174000 configuration: type: object properties: retry: type: object properties: maximumAttempts: type: integer minimum: 1 default: 3 description: >- Maximum number of attempts to retry the run in case of failure example: 3 description: >- The retry policy of the job. Configure how many retries and the delay between them for each payload. example: maximumAttempts: 3 maxConcurrentRequests: type: number minimum: 1 maximum: 25 description: >- The batch size of payloads to execute. This does not guarantee that the payloads will be executed at the same time. requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 maxRuns: type: integer minimum: 1 description: The maximum number of runs for the job. proxy: type: string format: uri description: Proxy URL for the job to use when making API calls example: http://username:password@proxy.example.com:8080 description: Job configuration settings payload: type: array items: type: object properties: parameters: type: object additionalProperties: true description: The parameters to be passed to the API. example: param1: value1 param2: 42 param3: true requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 retry: type: object properties: maximumAttempts: type: integer minimum: 1 default: 3 description: >- Maximum number of attempts to retry the run in case of failure example: 3 description: Retry policy configurations in case of failure. example: maximumAttempts: 3 apiName: type: string description: >- The name of the API to be executed. This is the file path relative to the `api` folder inside your project. required: - parameters - apiName description: Array of API calls to be executed sink: anyOf: - type: object properties: type: type: string enum: - webhook url: type: string description: The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token skipOnFail: type: boolean default: false description: >- If true, the webhook will not be sent if the API execution fails. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the webhook. If not provided, all APIs will be sent. example: - api1 - api2 required: - type - url description: Configuration for the webhook sink. title: Webhook Sink Configuration - type: object properties: type: type: string enum: - s3 bucket: type: string description: >- The name of the S3 bucket where the data will be stored. example: my-s3-bucket accessKeyId: type: string description: The access key ID for the S3 bucket. example: AKIAIOSFODNN7EXSSPLE secretAccessKey: type: string description: The secret access key for the S3 bucket. example: wJalrXUtnFFFI/K7MDENG/bPxRfiCYEXAMPLEKEY region: type: string description: The region where the S3 bucket is located. example: us-west-2 prefix: type: string description: >- Optional prefix for the S3 objects. This can be used to organize objects within the bucket. example: my-prefix/ skipOnFail: type: boolean default: false description: >- If enabled, failed payload runs will ***not*** be written to the bucket. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the S3 bucket. If not provided, all APIs will be sent. example: - api1 - api2 endpoint: type: string description: >- Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services. example: https://s3.custom-endpoint.com forcePathStyle: type: boolean description: >- If true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access. example: true required: - type - bucket - accessKeyId - secretAccessKey - region description: Configuration for the S3 sink. title: S3 Sink Configuration - type: 'null' description: >- Optional sink configuration for the job. Can be a webhook or S3 Compatible sink. schedule: type: - object - 'null' properties: jitter: anyOf: - type: integer minimum: 0 - type: string minLength: 1 intervals: type: array items: type: object properties: every: anyOf: - type: integer minimum: 0 description: number of milliseconds of interval - type: string minLength: 1 format: ms description: >- interval string, [ms-formatted string](https://github.com/vercel/ms) string required: - every description: >- An interval object, which represents a period to trigger the job. The interval is relative to the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time). description: An array of interval objects calendars: type: array items: type: object properties: second: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: array items: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: string enum: - '*' description: >- Seconds of the calendar, a number in the range 0 - 59 minute: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: array items: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: string enum: - '*' description: >- Minutes of the calendar, a number in the range 0 - 59 hour: anyOf: - type: integer minimum: 0 maximum: 23 - type: object properties: start: type: integer minimum: 0 maximum: 23 step: type: integer end: type: integer minimum: 0 maximum: 23 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 23 end: type: integer minimum: 0 maximum: 23 required: - start - type: array items: anyOf: - type: integer minimum: 0 maximum: 23 - type: object properties: start: type: integer minimum: 0 maximum: 23 step: type: integer end: type: integer minimum: 0 maximum: 23 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 23 end: type: integer minimum: 0 maximum: 23 required: - start - type: string enum: - '*' description: >- Hours of the calendar, a number in the range 0 - 23 dayOfWeek: anyOf: - type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY step: type: integer end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - step - end - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - type: array items: anyOf: - type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY step: type: integer end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - step - end - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - type: string enum: - '*' description: >- Days of week, one of SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY dayOfMonth: anyOf: - type: integer minimum: 1 maximum: 31 - type: object properties: start: type: integer minimum: 1 maximum: 31 step: type: integer end: type: integer minimum: 1 maximum: 31 required: - start - step - end - type: object properties: start: type: integer minimum: 1 maximum: 31 end: type: integer minimum: 1 maximum: 31 required: - start - type: array items: anyOf: - type: integer minimum: 1 maximum: 31 - type: object properties: start: type: integer minimum: 1 maximum: 31 step: type: integer end: type: integer minimum: 1 maximum: 31 required: - start - step - end - type: object properties: start: type: integer minimum: 1 maximum: 31 end: type: integer minimum: 1 maximum: 31 required: - start - type: string enum: - '*' description: >- Days of the month, a number in the range 1 - 31 month: anyOf: - type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER step: type: integer end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - step - end - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - type: array items: anyOf: - type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER step: type: integer end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - step - end - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - type: string enum: - '*' description: >- Months, one of JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER year: anyOf: - type: integer minimum: 1970 maximum: 9999 - type: object properties: start: type: integer minimum: 1970 maximum: 9999 step: type: integer end: type: integer minimum: 1970 maximum: 9999 required: - start - step - end - type: object properties: start: type: integer minimum: 1970 maximum: 9999 end: type: integer minimum: 1970 maximum: 9999 required: - start - type: array items: anyOf: - type: integer minimum: 1970 maximum: 9999 - type: object properties: start: type: integer minimum: 1970 maximum: 9999 step: type: integer end: type: integer minimum: 1970 maximum: 9999 required: - start - step - end - type: object properties: start: type: integer minimum: 1970 maximum: 9999 end: type: integer minimum: 1970 maximum: 9999 required: - start - type: string enum: - '*' description: 'Full year. For example: 2024' comment: type: string description: >- A comment to describe what the calendar is supposed to represent description: >- A calendar object. It is similar to a cron string, but more verbose. description: An array of calendar objects description: >- Schedule configurations for the job. If set, the job will periodically run according to this configuration. The configurations are used to calculate the closest next run time. next_run_time: type: - string - 'null' description: >- The timestamp of the next scheduled job run. `null` if the job does not have a schedule. example: '2024-01-01T00:00:00Z' last_run_time: type: - string - 'null' description: Timestamp of the last completed run example: '2024-01-01T00:00:00Z' created_at: type: string description: Timestamp when the job was created example: '2024-01-01T00:00:00Z' auth_session: type: - object - 'null' properties: id: type: string checkAttempts: type: integer default: 3 description: >- Number of attempts to check the validity of the AuthSession before recreating it. example: 3 createAttempts: type: integer default: 3 description: >- Number of attempts to create a new AuthSession if the current one is invalid or expired. example: 3 saveTrace: type: boolean required: - id description: Authentication session information for the job example: id: auth-session-123 notifications: type: - array - 'null' items: oneOf: - type: object properties: type: type: string enum: - webhook url: type: string description: >- The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token required: - type - url description: >- Array of notification configurations for the job. Notifications are sent when jobs reach a terminal state. proxy: type: - object - 'null' properties: version: type: string enum: - v1 url: type: string format: uri required: - version - url description: Proxy configuration for the job, stored as JSONB reason: type: - object - 'null' properties: type: type: string enum: - paused - terminated message: type: string details: {} timestamp: type: string format: date-time required: - type - message description: Reason for job state change, stored as JSONB state: type: string enum: - ACTIVE - PAUSED description: Current state of the job schedule_id: type: - string - 'null' description: ID of the temporal schedule associated with this job example: job-run-schedule-123 source: type: string enum: - API - CODE default: API description: >- Source of the job - 'API' for jobs created via API/UI, 'CODE' for jobs defined in the jobs/ folder example: API required: - id - workspace_id - project_id - configuration - payload - created_at - state description: Complete job object as stored in the database title: Job DB Object Schema '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId post: tags: - projects.jobs summary: Create Job description: Create a new Job for a Project. operationId: createJob x-speakeasy-name-override: create parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName x-codeSamples: - lang: typescript label: createJob source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.jobs.create( "my-project", { id: "123e4567-e89b-12d3-a456-426614174000", payload: [ { parameters: { "param1": "value1", "param2": 42, "param3": true }, requestTimeout: 600, retry: { "maximumAttempts": 3 }, apiName: "value", }, ], configuration: { retry: { "maximumAttempts": 3 }, maxConcurrentRequests: 1, requestTimeout: 600, maxRuns: 1, proxy: "http://username:password@proxy.example.com:8080", }, }, ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient from intuned_client import models import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.jobs.create( project_name="my-project", body=models.JobsCreateRequestBody( id="123e4567-e89b-12d3-a456-426614174000", payload=[ { "parameters": { "param1": "value1", "param2": 42, "param3": True, }, "apiName": "my-awesome-api", "requestTimeout": 600, }, ], configuration={ "retry": { "maximumAttempts": 3, }, "maxConcurrentRequests": 1, }, schedule={ "jitter": 1, "intervals": [ { "every": 1, }, ], }, proxy="http://username:password@proxy.example.com:8080", ), ) print(res) requestBody: description: Job creation input schema required: true content: application/json: schema: type: object properties: id: type: string minLength: 1 pattern: ^[a-zA-Z0-9\-_]+$ description: The ID of the job. Has to be a valid URL slug. example: 123e4567-e89b-12d3-a456-426614174000 payload: type: array items: type: object properties: parameters: type: object additionalProperties: true description: The parameters to be passed to the API. example: param1: value1 param2: 42 param3: true requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 retry: type: object properties: maximumAttempts: type: integer minimum: 1 default: 3 description: >- Maximum number of attempts to retry the run in case of failure example: 3 description: Retry policy configurations in case of failure. example: maximumAttempts: 3 apiName: type: string description: >- The name of the API to be executed. This is the file path relative to the `api` folder inside your project. required: - parameters - apiName description: Array of API calls to be executed configuration: type: object properties: retry: type: object properties: maximumAttempts: type: integer minimum: 1 default: 3 description: >- Maximum number of attempts to retry the run in case of failure example: 3 description: >- The retry policy of the job. Configure how many retries and the delay between them for each payload. example: maximumAttempts: 3 maxConcurrentRequests: type: number minimum: 1 maximum: 25 description: >- The batch size of payloads to execute. This does not guarantee that the payloads will be executed at the same time. requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 maxRuns: type: integer minimum: 1 description: The maximum number of runs for the job. proxy: type: string format: uri description: Proxy URL for the job to use when making API calls example: http://username:password@proxy.example.com:8080 description: Job configuration settings schedule: type: - object - 'null' properties: jitter: anyOf: - type: integer minimum: 0 - type: string minLength: 1 intervals: type: array items: type: object properties: every: anyOf: - type: integer minimum: 0 description: number of milliseconds of interval - type: string minLength: 1 format: ms description: >- interval string, [ms-formatted string](https://github.com/vercel/ms) string required: - every description: >- An interval object, which represents a period to trigger the job. The interval is relative to the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time). description: An array of interval objects calendars: type: array items: type: object properties: second: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: array items: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: string enum: - '*' description: >- Seconds of the calendar, a number in the range 0 - 59 minute: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: array items: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: string enum: - '*' description: >- Minutes of the calendar, a number in the range 0 - 59 hour: anyOf: - type: integer minimum: 0 maximum: 23 - type: object properties: start: type: integer minimum: 0 maximum: 23 step: type: integer end: type: integer minimum: 0 maximum: 23 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 23 end: type: integer minimum: 0 maximum: 23 required: - start - type: array items: anyOf: - type: integer minimum: 0 maximum: 23 - type: object properties: start: type: integer minimum: 0 maximum: 23 step: type: integer end: type: integer minimum: 0 maximum: 23 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 23 end: type: integer minimum: 0 maximum: 23 required: - start - type: string enum: - '*' description: >- Hours of the calendar, a number in the range 0 - 23 dayOfWeek: anyOf: - type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY step: type: integer end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - step - end - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - type: array items: anyOf: - type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY step: type: integer end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - step - end - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - type: string enum: - '*' description: >- Days of week, one of SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY dayOfMonth: anyOf: - type: integer minimum: 1 maximum: 31 - type: object properties: start: type: integer minimum: 1 maximum: 31 step: type: integer end: type: integer minimum: 1 maximum: 31 required: - start - step - end - type: object properties: start: type: integer minimum: 1 maximum: 31 end: type: integer minimum: 1 maximum: 31 required: - start - type: array items: anyOf: - type: integer minimum: 1 maximum: 31 - type: object properties: start: type: integer minimum: 1 maximum: 31 step: type: integer end: type: integer minimum: 1 maximum: 31 required: - start - step - end - type: object properties: start: type: integer minimum: 1 maximum: 31 end: type: integer minimum: 1 maximum: 31 required: - start - type: string enum: - '*' description: Days of the month, a number in the range 1 - 31 month: anyOf: - type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER step: type: integer end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - step - end - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - type: array items: anyOf: - type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER step: type: integer end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - step - end - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - type: string enum: - '*' description: >- Months, one of JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER year: anyOf: - type: integer minimum: 1970 maximum: 9999 - type: object properties: start: type: integer minimum: 1970 maximum: 9999 step: type: integer end: type: integer minimum: 1970 maximum: 9999 required: - start - step - end - type: object properties: start: type: integer minimum: 1970 maximum: 9999 end: type: integer minimum: 1970 maximum: 9999 required: - start - type: array items: anyOf: - type: integer minimum: 1970 maximum: 9999 - type: object properties: start: type: integer minimum: 1970 maximum: 9999 step: type: integer end: type: integer minimum: 1970 maximum: 9999 required: - start - step - end - type: object properties: start: type: integer minimum: 1970 maximum: 9999 end: type: integer minimum: 1970 maximum: 9999 required: - start - type: string enum: - '*' description: 'Full year. For example: 2024' comment: type: string description: >- A comment to describe what the calendar is supposed to represent description: >- A calendar object. It is similar to a cron string, but more verbose. description: An array of calendar objects description: >- Schedule configurations for the job. If set, the job will periodically run according to this configuration. The configurations are used to calculate the closest next run time. sink: anyOf: - type: object properties: type: type: string enum: - webhook url: type: string description: The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token skipOnFail: type: boolean default: false description: >- If true, the webhook will not be sent if the API execution fails. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the webhook. If not provided, all APIs will be sent. example: - api1 - api2 required: - type - url description: Configuration for the webhook sink. title: Webhook Sink Configuration - type: object properties: type: type: string enum: - s3 bucket: type: string description: >- The name of the S3 bucket where the data will be stored. example: my-s3-bucket accessKeyId: type: string description: The access key ID for the S3 bucket. example: AKIAIOSFODNN7EXSSPLE secretAccessKey: type: string description: The secret access key for the S3 bucket. example: wJalrXUtnFFFI/K7MDENG/bPxRfiCYEXAMPLEKEY region: type: string description: The region where the S3 bucket is located. example: us-west-2 prefix: type: string description: >- Optional prefix for the S3 objects. This can be used to organize objects within the bucket. example: my-prefix/ skipOnFail: type: boolean default: false description: >- If enabled, failed payload runs will ***not*** be written to the bucket. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the S3 bucket. If not provided, all APIs will be sent. example: - api1 - api2 endpoint: type: string description: >- Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services. example: https://s3.custom-endpoint.com forcePathStyle: type: boolean description: >- If true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access. example: true required: - type - bucket - accessKeyId - secretAccessKey - region description: Configuration for the S3 sink. title: S3 Sink Configuration - type: 'null' description: >- Optional sink configuration for the job. Can be a webhook or S3 Compatible sink. proxy: type: - string - 'null' description: Proxy configuration for the job example: http://username:password@proxy.example.com:8080 auth_session: type: - object - 'null' properties: id: type: string checkAttempts: type: integer default: 3 description: >- Number of attempts to check the validity of the AuthSession before recreating it. example: 3 createAttempts: type: integer default: 3 description: >- Number of attempts to create a new AuthSession if the current one is invalid or expired. example: 3 saveTrace: type: boolean required: - id notifications: type: - array - 'null' items: oneOf: - type: object properties: type: type: string enum: - webhook url: type: string description: The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token required: - type - url required: - id - payload - configuration example: id: my-awesome-job configuration: retry: maximumAttempts: 3 payload: - apiName: my-awesome-api parameters: param1: value1 param2: 42 param3: true responses: '201': description: Job created successfully. content: application/json: schema: type: object properties: id: type: string description: The ID of the created job. message: type: string enum: - created required: - id - message '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId /{workspaceId}/projects/{projectName}/jobs/{jobId}: get: tags: - projects.jobs summary: Get Job description: Get a Job by ID. operationId: getJob x-speakeasy-name-override: one parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: The ID you assigned when creating the Job. example: my-sample-job in: path name: jobId x-codeSamples: - lang: typescript label: getJob source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.jobs.one( "my-project", "my-sample-job", ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.jobs.get( project_name="my-project", job_id="my-sample-job", ) print(res) responses: '200': description: Detailed information about a specific job content: application/json: schema: type: object properties: id: type: string minLength: 1 pattern: ^[a-zA-Z0-9\-_]+$ description: The ID of the job. Has to be a valid URL slug. example: 123e4567-e89b-12d3-a456-426614174000 configuration: type: object properties: retry: type: object properties: maximumAttempts: type: integer minimum: 1 default: 3 description: >- Maximum number of attempts to retry the run in case of failure example: 3 description: >- The retry policy of the job. Configure how many retries and the delay between them for each payload. example: maximumAttempts: 3 maxConcurrentRequests: type: number minimum: 1 maximum: 25 description: >- The batch size of payloads to execute. This does not guarantee that the payloads will be executed at the same time. requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 maxRuns: type: integer minimum: 1 description: The maximum number of runs for the job. proxy: type: string format: uri description: Proxy URL for the job to use when making API calls example: http://username:password@proxy.example.com:8080 description: Job configuration settings sink: anyOf: - type: object properties: type: type: string enum: - webhook url: type: string description: The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token skipOnFail: type: boolean default: false description: >- If true, the webhook will not be sent if the API execution fails. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the webhook. If not provided, all APIs will be sent. example: - api1 - api2 required: - type - url description: Configuration for the webhook sink. title: Webhook Sink Configuration - type: object properties: type: type: string enum: - s3 bucket: type: string description: >- The name of the S3 bucket where the data will be stored. example: my-s3-bucket accessKeyId: type: string description: The access key ID for the S3 bucket. example: AKIAIOSFODNN7EXSSPLE secretAccessKey: type: string description: The secret access key for the S3 bucket. example: wJalrXUtnFFFI/K7MDENG/bPxRfiCYEXAMPLEKEY region: type: string description: The region where the S3 bucket is located. example: us-west-2 prefix: type: string description: >- Optional prefix for the S3 objects. This can be used to organize objects within the bucket. example: my-prefix/ skipOnFail: type: boolean default: false description: >- If enabled, failed payload runs will ***not*** be written to the bucket. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the S3 bucket. If not provided, all APIs will be sent. example: - api1 - api2 endpoint: type: string description: >- Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services. example: https://s3.custom-endpoint.com forcePathStyle: type: boolean description: >- If true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access. example: true required: - type - bucket - accessKeyId - secretAccessKey - region description: Configuration for the S3 sink. title: S3 Sink Configuration - type: 'null' description: >- Optional sink configuration for the job. Can be a webhook or S3 Compatible sink. created_at: type: string description: Timestamp when the job was created example: '2024-01-01T00:00:00Z' next_run_time: type: - string - 'null' description: >- The timestamp of the next scheduled job run. `null` if the job does not have a schedule. example: '2024-01-01T00:00:00Z' last_run_time: type: - string - 'null' description: Timestamp of the last completed run example: '2024-01-01T00:00:00Z' state: type: string enum: - ACTIVE - PAUSED description: Current state of the job payload: type: array items: type: object properties: parameters: type: object additionalProperties: true description: The parameters to be passed to the API. example: param1: value1 param2: 42 param3: true requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 retry: type: object properties: maximumAttempts: type: integer minimum: 1 default: 3 description: >- Maximum number of attempts to retry the run in case of failure example: 3 description: Retry policy configurations in case of failure. example: maximumAttempts: 3 apiName: type: string description: >- The name of the API to be executed. This is the file path relative to the `api` folder inside your project. required: - parameters - apiName description: Array of API calls to be executed schedule: type: - object - 'null' properties: jitter: anyOf: - type: integer minimum: 0 - type: string minLength: 1 intervals: type: array items: type: object properties: every: anyOf: - type: integer minimum: 0 description: number of milliseconds of interval - type: string minLength: 1 format: ms description: >- interval string, [ms-formatted string](https://github.com/vercel/ms) string required: - every description: >- An interval object, which represents a period to trigger the job. The interval is relative to the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time). description: An array of interval objects calendars: type: array items: type: object properties: second: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: array items: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: string enum: - '*' description: >- Seconds of the calendar, a number in the range 0 - 59 minute: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: array items: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: string enum: - '*' description: >- Minutes of the calendar, a number in the range 0 - 59 hour: anyOf: - type: integer minimum: 0 maximum: 23 - type: object properties: start: type: integer minimum: 0 maximum: 23 step: type: integer end: type: integer minimum: 0 maximum: 23 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 23 end: type: integer minimum: 0 maximum: 23 required: - start - type: array items: anyOf: - type: integer minimum: 0 maximum: 23 - type: object properties: start: type: integer minimum: 0 maximum: 23 step: type: integer end: type: integer minimum: 0 maximum: 23 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 23 end: type: integer minimum: 0 maximum: 23 required: - start - type: string enum: - '*' description: >- Hours of the calendar, a number in the range 0 - 23 dayOfWeek: anyOf: - type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY step: type: integer end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - step - end - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - type: array items: anyOf: - type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY step: type: integer end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - step - end - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - type: string enum: - '*' description: >- Days of week, one of SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY dayOfMonth: anyOf: - type: integer minimum: 1 maximum: 31 - type: object properties: start: type: integer minimum: 1 maximum: 31 step: type: integer end: type: integer minimum: 1 maximum: 31 required: - start - step - end - type: object properties: start: type: integer minimum: 1 maximum: 31 end: type: integer minimum: 1 maximum: 31 required: - start - type: array items: anyOf: - type: integer minimum: 1 maximum: 31 - type: object properties: start: type: integer minimum: 1 maximum: 31 step: type: integer end: type: integer minimum: 1 maximum: 31 required: - start - step - end - type: object properties: start: type: integer minimum: 1 maximum: 31 end: type: integer minimum: 1 maximum: 31 required: - start - type: string enum: - '*' description: Days of the month, a number in the range 1 - 31 month: anyOf: - type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER step: type: integer end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - step - end - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - type: array items: anyOf: - type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER step: type: integer end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - step - end - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - type: string enum: - '*' description: >- Months, one of JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER year: anyOf: - type: integer minimum: 1970 maximum: 9999 - type: object properties: start: type: integer minimum: 1970 maximum: 9999 step: type: integer end: type: integer minimum: 1970 maximum: 9999 required: - start - step - end - type: object properties: start: type: integer minimum: 1970 maximum: 9999 end: type: integer minimum: 1970 maximum: 9999 required: - start - type: array items: anyOf: - type: integer minimum: 1970 maximum: 9999 - type: object properties: start: type: integer minimum: 1970 maximum: 9999 step: type: integer end: type: integer minimum: 1970 maximum: 9999 required: - start - step - end - type: object properties: start: type: integer minimum: 1970 maximum: 9999 end: type: integer minimum: 1970 maximum: 9999 required: - start - type: string enum: - '*' description: 'Full year. For example: 2024' comment: type: string description: >- A comment to describe what the calendar is supposed to represent description: >- A calendar object. It is similar to a cron string, but more verbose. description: An array of calendar objects description: >- Schedule configurations for the job. If set, the job will periodically run according to this configuration. The configurations are used to calculate the closest next run time. projectId: type: string format: uuid description: UUID of the project this job belongs to example: 123e4567-e89b-12d3-a456-426614174000 auth_session: type: - object - 'null' properties: id: type: string checkAttempts: type: integer default: 3 description: >- Number of attempts to check the validity of the AuthSession before recreating it. example: 3 createAttempts: type: integer default: 3 description: >- Number of attempts to create a new AuthSession if the current one is invalid or expired. example: 3 saveTrace: type: boolean required: - id description: Authentication session information for the job example: id: auth-session-123 proxy: type: string description: Proxy URL if configured for the job example: http://username:password@proxy.example.com:8080 required: - id - configuration - created_at - state - projectId description: Detailed information about a specific job title: Job Details Response '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId put: tags: - projects.jobs summary: Update Job description: Update a Job by ID. operationId: updateJob x-speakeasy-name-override: update parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: The ID you assigned when creating the Job. example: my-sample-job in: path name: jobId x-codeSamples: - lang: typescript label: updateJob source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.jobs.update( "my-project", "my-sample-job", { payload: [ { parameters: { "param1": "value1", "param2": 42, "param3": true }, requestTimeout: 600, retry: { "maximumAttempts": 3 }, apiName: "value", }, ], configuration: { retry: { "maximumAttempts": 3 }, maxConcurrentRequests: 1, requestTimeout: 600, maxRuns: 1, proxy: "http://username:password@proxy.example.com:8080", }, }, ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient from intuned_client import models import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.jobs.update( project_name="my-project", job_id="my-sample-job", body=models.JobsUpdateRequestBody( payload=[ { "parameters": { "param1": "value1", "param2": 42, "param3": True, }, "apiName": "my-awesome-api", "requestTimeout": 600, }, ], configuration={ "retry": { "maximumAttempts": 3, }, "maxConcurrentRequests": 1, }, schedule={ "jitter": 1, "intervals": [ { "every": 1, }, ], }, sink={ "type": "webhook", "url": "https://example.com/webhook", "headers": { "Content-Type": "application/json", "Authorization": "Bearer token", }, }, proxy="http://username:password@proxy.example.com:8080", ), ) print(res) requestBody: description: Job update input schema required: true content: application/json: schema: type: object properties: payload: type: array items: type: object properties: parameters: type: object additionalProperties: true description: The parameters to be passed to the API. example: param1: value1 param2: 42 param3: true requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 retry: type: object properties: maximumAttempts: type: integer minimum: 1 default: 3 description: >- Maximum number of attempts to retry the run in case of failure example: 3 description: Retry policy configurations in case of failure. example: maximumAttempts: 3 apiName: type: string description: >- The name of the API to be executed. This is the file path relative to the `api` folder inside your project. required: - parameters - apiName description: Array of API calls to be executed configuration: type: object properties: retry: type: object properties: maximumAttempts: type: integer minimum: 1 default: 3 description: >- Maximum number of attempts to retry the run in case of failure example: 3 description: >- The retry policy of the job. Configure how many retries and the delay between them for each payload. example: maximumAttempts: 3 maxConcurrentRequests: type: number minimum: 1 maximum: 25 description: >- The batch size of payloads to execute. This does not guarantee that the payloads will be executed at the same time. requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 maxRuns: type: integer minimum: 1 description: The maximum number of runs for the job. proxy: type: string format: uri description: Proxy URL for the job to use when making API calls example: http://username:password@proxy.example.com:8080 description: Job configuration settings schedule: type: - object - 'null' properties: jitter: anyOf: - type: integer minimum: 0 - type: string minLength: 1 intervals: type: array items: type: object properties: every: anyOf: - type: integer minimum: 0 description: number of milliseconds of interval - type: string minLength: 1 format: ms description: >- interval string, [ms-formatted string](https://github.com/vercel/ms) string required: - every description: >- An interval object, which represents a period to trigger the job. The interval is relative to the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time). description: An array of interval objects calendars: type: array items: type: object properties: second: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: array items: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: string enum: - '*' description: >- Seconds of the calendar, a number in the range 0 - 59 minute: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: array items: anyOf: - type: integer minimum: 0 maximum: 59 - type: object properties: start: type: integer minimum: 0 maximum: 59 step: type: integer end: type: integer minimum: 0 maximum: 59 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 59 end: type: integer minimum: 0 maximum: 59 required: - start - type: string enum: - '*' description: >- Minutes of the calendar, a number in the range 0 - 59 hour: anyOf: - type: integer minimum: 0 maximum: 23 - type: object properties: start: type: integer minimum: 0 maximum: 23 step: type: integer end: type: integer minimum: 0 maximum: 23 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 23 end: type: integer minimum: 0 maximum: 23 required: - start - type: array items: anyOf: - type: integer minimum: 0 maximum: 23 - type: object properties: start: type: integer minimum: 0 maximum: 23 step: type: integer end: type: integer minimum: 0 maximum: 23 required: - start - step - end - type: object properties: start: type: integer minimum: 0 maximum: 23 end: type: integer minimum: 0 maximum: 23 required: - start - type: string enum: - '*' description: >- Hours of the calendar, a number in the range 0 - 23 dayOfWeek: anyOf: - type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY step: type: integer end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - step - end - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - type: array items: anyOf: - type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY step: type: integer end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - step - end - type: object properties: start: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY end: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY required: - start - type: string enum: - '*' description: >- Days of week, one of SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY dayOfMonth: anyOf: - type: integer minimum: 1 maximum: 31 - type: object properties: start: type: integer minimum: 1 maximum: 31 step: type: integer end: type: integer minimum: 1 maximum: 31 required: - start - step - end - type: object properties: start: type: integer minimum: 1 maximum: 31 end: type: integer minimum: 1 maximum: 31 required: - start - type: array items: anyOf: - type: integer minimum: 1 maximum: 31 - type: object properties: start: type: integer minimum: 1 maximum: 31 step: type: integer end: type: integer minimum: 1 maximum: 31 required: - start - step - end - type: object properties: start: type: integer minimum: 1 maximum: 31 end: type: integer minimum: 1 maximum: 31 required: - start - type: string enum: - '*' description: Days of the month, a number in the range 1 - 31 month: anyOf: - type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER step: type: integer end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - step - end - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - type: array items: anyOf: - type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER step: type: integer end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - step - end - type: object properties: start: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER end: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER required: - start - type: string enum: - '*' description: >- Months, one of JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER year: anyOf: - type: integer minimum: 1970 maximum: 9999 - type: object properties: start: type: integer minimum: 1970 maximum: 9999 step: type: integer end: type: integer minimum: 1970 maximum: 9999 required: - start - step - end - type: object properties: start: type: integer minimum: 1970 maximum: 9999 end: type: integer minimum: 1970 maximum: 9999 required: - start - type: array items: anyOf: - type: integer minimum: 1970 maximum: 9999 - type: object properties: start: type: integer minimum: 1970 maximum: 9999 step: type: integer end: type: integer minimum: 1970 maximum: 9999 required: - start - step - end - type: object properties: start: type: integer minimum: 1970 maximum: 9999 end: type: integer minimum: 1970 maximum: 9999 required: - start - type: string enum: - '*' description: 'Full year. For example: 2024' comment: type: string description: >- A comment to describe what the calendar is supposed to represent description: >- A calendar object. It is similar to a cron string, but more verbose. description: An array of calendar objects description: >- Schedule configurations for the job. If set, the job will periodically run according to this configuration. The configurations are used to calculate the closest next run time. sink: anyOf: - type: object properties: type: type: string enum: - webhook url: type: string description: The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token skipOnFail: type: boolean default: false description: >- If true, the webhook will not be sent if the API execution fails. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the webhook. If not provided, all APIs will be sent. example: - api1 - api2 required: - type - url description: Configuration for the webhook sink. title: Webhook Sink Configuration - type: object properties: type: type: string enum: - s3 bucket: type: string description: >- The name of the S3 bucket where the data will be stored. example: my-s3-bucket accessKeyId: type: string description: The access key ID for the S3 bucket. example: AKIAIOSFODNN7EXSSPLE secretAccessKey: type: string description: The secret access key for the S3 bucket. example: wJalrXUtnFFFI/K7MDENG/bPxRfiCYEXAMPLEKEY region: type: string description: The region where the S3 bucket is located. example: us-west-2 prefix: type: string description: >- Optional prefix for the S3 objects. This can be used to organize objects within the bucket. example: my-prefix/ skipOnFail: type: boolean default: false description: >- If enabled, failed payload runs will ***not*** be written to the bucket. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the S3 bucket. If not provided, all APIs will be sent. example: - api1 - api2 endpoint: type: string description: >- Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services. example: https://s3.custom-endpoint.com forcePathStyle: type: boolean description: >- If true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access. example: true required: - type - bucket - accessKeyId - secretAccessKey - region description: Configuration for the S3 sink. title: S3 Sink Configuration - type: 'null' description: >- Optional sink configuration for the job. Can be a webhook or S3 Compatible sink. proxy: type: - string - 'null' description: Proxy configuration for the job example: http://username:password@proxy.example.com:8080 auth_session: type: - object - 'null' properties: id: type: string checkAttempts: type: integer default: 3 description: >- Number of attempts to check the validity of the AuthSession before recreating it. example: 3 createAttempts: type: integer default: 3 description: >- Number of attempts to create a new AuthSession if the current one is invalid or expired. example: 3 saveTrace: type: boolean required: - id notifications: type: - array - 'null' items: oneOf: - type: object properties: type: type: string enum: - webhook url: type: string description: The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token required: - type - url required: - payload - configuration description: Input schema for updating an existing job title: Update Job Input Schema example: configuration: retry: maximumAttempts: 3 payload: - apiName: my-awesome-api parameters: param1: value1 param2: 42 param3: true responses: '200': description: Job updated successfully. content: application/json: schema: type: object properties: id: type: string description: The ID of the updated job. message: type: string enum: - updated job successfully required: - id - message '201': description: Job updated successfully. content: application/json: schema: type: object properties: id: type: string description: The ID of the updated job. message: type: string enum: - updated job successfully required: - id - message '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId delete: tags: - projects.jobs summary: Delete Job description: Delete a Job by ID. operationId: deleteJob x-speakeasy-name-override: delete parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: The ID you assigned when creating the Job. example: my-sample-job in: path name: jobId x-codeSamples: - lang: typescript label: deleteJob source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { await client.projects.jobs.delete( "my-project", "my-sample-job", ); console.log("Request completed successfully"); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: client.projects.jobs.delete( project_name="my-project", job_id="my-sample-job", ) print("Request completed successfully") responses: '204': description: Job deleted successfully '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId /{workspaceId}/projects/{projectName}/jobs/{jobId}/pause: post: tags: - projects.jobs summary: Pause Job description: Pause a Job. Pauses any JobRuns and the Job schedule if applicable. operationId: pauseJob x-speakeasy-name-override: pause parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: The ID you assigned when creating the Job. example: my-sample-job in: path name: jobId x-codeSamples: - lang: typescript label: pauseJob source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.jobs.pause( "my-project", "my-sample-job", ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.jobs.pause( project_name="my-project", job_id="my-sample-job", ) print(res) responses: '200': description: Job paused successfully. content: application/json: schema: type: object properties: message: type: string enum: - Paused required: - message '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId /{workspaceId}/projects/{projectName}/jobs/{jobId}/resume: post: tags: - projects.jobs summary: Resume Job description: >- Resume a paused Job. Resumes any paused JobRuns and the Job schedule if applicable. operationId: resumeJob x-speakeasy-name-override: resume parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: The ID you assigned when creating the Job. example: my-sample-job in: path name: jobId x-codeSamples: - lang: typescript label: resumeJob source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.jobs.resume( "my-project", "my-sample-job", ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.jobs.resume( project_name="my-project", job_id="my-sample-job", ) print(res) responses: '200': description: Job resumed successfully. content: application/json: schema: type: object properties: message: type: string enum: - Resumed required: - message '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId /{workspaceId}/projects/{projectName}/jobs/{jobId}/trigger: post: tags: - projects.jobs summary: Trigger Job description: Manually trigger a JobRun. Fails if the Job is paused. operationId: triggerJob x-speakeasy-name-override: trigger parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: The ID you assigned when creating the Job. example: my-sample-job in: path name: jobId x-codeSamples: - lang: typescript label: triggerJob source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.jobs.trigger( "my-project", "my-sample-job", ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.jobs.trigger( project_name="my-project", job_id="my-sample-job", ) print(res) responses: '200': description: Job triggered successfully. content: application/json: schema: type: object properties: jobRunId: type: string description: The ID of the triggered JobRun. message: type: string description: A message indicating the result of the trigger action. required: - jobRunId - message '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId /{workspaceId}/projects/{projectName}/jobs/{jobId}/runs: get: tags: - projects.jobs.runs summary: Get Job Runs description: Get all JobRuns for a Job. operationId: getJobRuns x-speakeasy-name-override: all parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: The ID you assigned when creating the Job. example: my-sample-job in: path name: jobId - schema: type: string description: Number of items per page (defaults to 10) example: '10' required: false name: pageSize in: query - schema: type: string description: Page number for pagination (defaults to 0) example: '0' required: false name: pageNumber in: query - schema: type: string description: >- Sorting parameter in format 'column,order/column2,order2'. Order can be 'asc' or 'desc' example: start_time,desc/status,asc required: false name: sortBy in: query x-codeSamples: - lang: typescript label: getJobRuns source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.jobs.runs.all( { projectName: "my-project", jobId: "my-sample-job", pageSize: "10", pageNumber: "0", sortBy: "start_time,desc/status,asc", }, ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.jobs.runs.list( project_name="my-project", job_id="my-sample-job", page_size="10", page_number="0", sort_by="start_time,desc/status,asc", ) print(res) responses: '200': description: Array of JobRuns with pagination info. content: application/json: schema: type: object properties: jobRuns: type: array items: type: object properties: id: type: string description: Unique identifier for the JobRun (jr_...). example: jr_abc123def456ghi789xyz start_time: type: string description: Timestamp when the JobRun started. example: '2024-01-01T00:00:00Z' end_time: type: - string - 'null' description: >- Timestamp when the job run ended (null if still running) example: '2024-01-01T00:30:00Z' workspace_id: type: string format: uuid description: UUID of the workspace this JobRun belongs to. example: 123e4567-e89b-12d3-a456-426614174000 project_id: type: string format: uuid description: UUID of the project this JobRun belongs to. example: 123e4567-e89b-12d3-a456-426614174000 job_id: type: string description: ID of the job this run belongs to example: job-123e4567-e89b-12d3 created_at: type: string description: Timestamp when the JobRun was created. example: '2024-01-01T00:00:00Z' updated_at: type: string description: Timestamp when the JobRun was last updated. example: '2024-01-01T00:00:00Z' type: type: string enum: - MANUAL - SCHEDULED description: Type of the JobRun. example: SCHEDULED status: type: string enum: - CANCELED - PENDING - PAUSED - PAUSING - RESUMING - SUCCESS - FAILURE - TERMINATED - COMPLETED description: Current status of the JobRun. example: SUCCESS payloads: type: - integer - 'null' description: Total number of payloads in the JobRun. example: 100 successful_runs: type: - integer - 'null' description: Number of successful API calls in the JobRun. example: 95 failed_runs: type: - integer - 'null' description: Number of failed API calls in the JobRun. example: 5 error: type: - object - 'null' properties: message: type: string description: Error message describing the failure example: An error occurred while executing the job code: type: string enum: - internal-server-error - insufficient-resource-credits description: >- Optional error code for more specific error identification example: internal-server-error details: {} category: type: string enum: - billing - infrastructure correlationId: type: string description: Optional correlation ID for tracking the error example: 123e4567-e89b-12d3-a456-426614174000 retirable: type: boolean default: false doc_url: type: string description: Optional documentation URL for more information example: https://intunedhq.com/docs/main/support/errors required: - message - code - category description: >- Error information if the job run failed, stored as JSONB reason: type: - object - 'null' properties: type: type: string enum: - terminated - user-request - auth-session-not-found - auth-session-invalid-mid-job - auth-session-validate-dependency-failed - auth-session-locked - another-job-run-active - insufficient-resource-credits - s3-sink-error message: type: string details: {} doc_url: type: string description: Optional documentation URL for more information example: >- https://intunedhq.com/docs/main/support/reasons#no-valid-output-received required: - type - message description: Reason for JobRun state change., stored as JSONB job_configuration_snapshot: type: object properties: configuration: type: object properties: retry: type: object properties: maximumAttempts: type: integer minimum: 1 default: 3 description: >- Maximum number of attempts to retry the run in case of failure example: 3 description: >- The retry policy of the job. Configure how many retries and the delay between them for each payload. example: maximumAttempts: 3 maxConcurrentRequests: type: number minimum: 1 maximum: 25 description: >- The batch size of payloads to execute. This does not guarantee that the payloads will be executed at the same time. requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 maxRuns: type: integer minimum: 1 description: The maximum number of runs for the job. proxy: type: string format: uri description: >- Proxy URL for the job to use when making API calls example: >- http://username:password@proxy.example.com:8080 description: Job configuration settings sink: anyOf: - type: object properties: type: type: string enum: - webhook url: type: string description: >- The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token skipOnFail: type: boolean default: false description: >- If true, the webhook will not be sent if the API execution fails. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the webhook. If not provided, all APIs will be sent. example: - api1 - api2 required: - type - url description: Configuration for the webhook sink. title: Webhook Sink Configuration - type: object properties: type: type: string enum: - s3 bucket: type: string description: >- The name of the S3 bucket where the data will be stored. example: my-s3-bucket accessKeyId: type: string description: The access key ID for the S3 bucket. example: AKIAIOSFODNN7EXSSPLE secretAccessKey: type: string description: The secret access key for the S3 bucket. example: wJalrXUtnFFFI/K7MDENG/bPxRfiCYEXAMPLEKEY region: type: string description: >- The region where the S3 bucket is located. example: us-west-2 prefix: type: string description: >- Optional prefix for the S3 objects. This can be used to organize objects within the bucket. example: my-prefix/ skipOnFail: type: boolean default: false description: >- If enabled, failed payload runs will ***not*** be written to the bucket. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the S3 bucket. If not provided, all APIs will be sent. example: - api1 - api2 endpoint: type: string description: >- Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services. example: https://s3.custom-endpoint.com forcePathStyle: type: boolean description: >- If true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access. example: true required: - type - bucket - accessKeyId - secretAccessKey - region description: Configuration for the S3 sink. title: S3 Sink Configuration - type: 'null' description: >- Optional sink configuration for the job. Can be a webhook or S3 Compatible sink. auth_session: type: - object - 'null' properties: id: type: string checkAttempts: type: integer default: 3 description: >- Number of attempts to check the validity of the AuthSession before recreating it. example: 3 createAttempts: type: integer default: 3 description: >- Number of attempts to create a new AuthSession if the current one is invalid or expired. example: 3 saveTrace: type: boolean required: - id description: Authentication session information for the job example: id: auth-session-123 proxy: type: - object - 'null' properties: version: type: string enum: - v1 url: type: string format: uri required: - version - url description: Proxy configuration for the job, stored as JSONB notifications: type: - array - 'null' items: oneOf: - type: object properties: type: type: string enum: - webhook url: type: string description: >- The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token required: - type - url description: >- Array of notification configurations for the job. Notifications are sent when jobs reach a terminal state. required: - configuration description: >- Snapshot of job configuration at the time of the job run required: - id - start_time - end_time - workspace_id - project_id - job_id - created_at - updated_at - type - status - payloads - successful_runs - failed_runs - job_configuration_snapshot totalCount: type: integer description: Total number of JobRuns available. example: 150 required: - jobRuns - totalCount '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId /{workspaceId}/projects/{projectName}/jobs/{jobId}/runs/{jobRunId}: get: tags: - projects.jobs.runs summary: Get Job Run description: Get information and results for a specific JobRun. operationId: getJobRun x-speakeasy-name-override: one parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: The ID you assigned when creating the Job. example: my-sample-job in: path name: jobId - schema: type: string required: true description: >- The JobRun ID. Get this from the list JobRuns endpoint or from the trigger Job response. example: jr_abc123def456ghi789xyz in: path name: jobRunId x-codeSamples: - lang: typescript label: getJobRun source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.jobs.runs.one( "my-project", "my-sample-job", "jr_abc123def456ghi789xyz", ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.jobs.runs.get( project_name="my-project", job_id="my-sample-job", job_run_id="jr_abc123def456ghi789xyz", ) print(res) responses: '200': description: JobRun information and results. content: application/json: schema: type: object properties: jobRun: type: object properties: id: type: string description: Unique identifier for the JobRun (jr_...). example: jr_abc123def456ghi789xyz start_time: type: string description: Timestamp when the JobRun started. example: '2024-01-01T00:00:00Z' end_time: type: - string - 'null' description: >- Timestamp when the job run ended (null if still running) example: '2024-01-01T00:30:00Z' workspace_id: type: string format: uuid description: UUID of the workspace this JobRun belongs to. example: 123e4567-e89b-12d3-a456-426614174000 project_id: type: string format: uuid description: UUID of the project this JobRun belongs to. example: 123e4567-e89b-12d3-a456-426614174000 job_id: type: string description: ID of the job this run belongs to example: job-123e4567-e89b-12d3 created_at: type: string description: Timestamp when the JobRun was created. example: '2024-01-01T00:00:00Z' updated_at: type: string description: Timestamp when the JobRun was last updated. example: '2024-01-01T00:00:00Z' type: type: string enum: - MANUAL - SCHEDULED description: Type of the JobRun. example: SCHEDULED status: type: string enum: - CANCELED - PENDING - PAUSED - PAUSING - RESUMING - SUCCESS - FAILURE - TERMINATED - COMPLETED description: Current status of the JobRun. example: SUCCESS payloads: type: - integer - 'null' description: Total number of payloads in the JobRun. example: 100 successful_runs: type: - integer - 'null' description: Number of successful API calls in the JobRun. example: 95 failed_runs: type: - integer - 'null' description: Number of failed API calls in the JobRun. example: 5 error: type: - object - 'null' properties: message: type: string description: Error message describing the failure example: An error occurred while executing the job code: type: string enum: - internal-server-error - insufficient-resource-credits description: >- Optional error code for more specific error identification example: internal-server-error details: {} category: type: string enum: - billing - infrastructure correlationId: type: string description: Optional correlation ID for tracking the error example: 123e4567-e89b-12d3-a456-426614174000 retirable: type: boolean default: false doc_url: type: string description: Optional documentation URL for more information example: https://intunedhq.com/docs/main/support/errors required: - message - code - category description: >- Error information if the job run failed, stored as JSONB reason: type: - object - 'null' properties: type: type: string enum: - terminated - user-request - auth-session-not-found - auth-session-invalid-mid-job - auth-session-validate-dependency-failed - auth-session-locked - another-job-run-active - insufficient-resource-credits - s3-sink-error message: type: string details: {} doc_url: type: string description: Optional documentation URL for more information example: >- https://intunedhq.com/docs/main/support/reasons#no-valid-output-received required: - type - message description: Reason for JobRun state change., stored as JSONB job_configuration_snapshot: type: object properties: configuration: type: object properties: retry: type: object properties: maximumAttempts: type: integer minimum: 1 default: 3 description: >- Maximum number of attempts to retry the run in case of failure example: 3 description: >- The retry policy of the job. Configure how many retries and the delay between them for each payload. example: maximumAttempts: 3 maxConcurrentRequests: type: number minimum: 1 maximum: 25 description: >- The batch size of payloads to execute. This does not guarantee that the payloads will be executed at the same time. requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 maxRuns: type: integer minimum: 1 description: The maximum number of runs for the job. proxy: type: string format: uri description: >- Proxy URL for the job to use when making API calls example: >- http://username:password@proxy.example.com:8080 description: Job configuration settings sink: anyOf: - type: object properties: type: type: string enum: - webhook url: type: string description: >- The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token skipOnFail: type: boolean default: false description: >- If true, the webhook will not be sent if the API execution fails. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the webhook. If not provided, all APIs will be sent. example: - api1 - api2 required: - type - url description: Configuration for the webhook sink. title: Webhook Sink Configuration - type: object properties: type: type: string enum: - s3 bucket: type: string description: >- The name of the S3 bucket where the data will be stored. example: my-s3-bucket accessKeyId: type: string description: The access key ID for the S3 bucket. example: AKIAIOSFODNN7EXSSPLE secretAccessKey: type: string description: The secret access key for the S3 bucket. example: wJalrXUtnFFFI/K7MDENG/bPxRfiCYEXAMPLEKEY region: type: string description: The region where the S3 bucket is located. example: us-west-2 prefix: type: string description: >- Optional prefix for the S3 objects. This can be used to organize objects within the bucket. example: my-prefix/ skipOnFail: type: boolean default: false description: >- If enabled, failed payload runs will ***not*** be written to the bucket. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the S3 bucket. If not provided, all APIs will be sent. example: - api1 - api2 endpoint: type: string description: >- Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services. example: https://s3.custom-endpoint.com forcePathStyle: type: boolean description: >- If true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access. example: true required: - type - bucket - accessKeyId - secretAccessKey - region description: Configuration for the S3 sink. title: S3 Sink Configuration - type: 'null' description: >- Optional sink configuration for the job. Can be a webhook or S3 Compatible sink. auth_session: type: - object - 'null' properties: id: type: string checkAttempts: type: integer default: 3 description: >- Number of attempts to check the validity of the AuthSession before recreating it. example: 3 createAttempts: type: integer default: 3 description: >- Number of attempts to create a new AuthSession if the current one is invalid or expired. example: 3 saveTrace: type: boolean required: - id description: Authentication session information for the job example: id: auth-session-123 proxy: type: - object - 'null' properties: version: type: string enum: - v1 url: type: string format: uri required: - version - url description: Proxy configuration for the job, stored as JSONB notifications: type: - array - 'null' items: oneOf: - type: object properties: type: type: string enum: - webhook url: type: string description: >- The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token required: - type - url description: >- Array of notification configurations for the job. Notifications are sent when jobs reach a terminal state. required: - configuration description: >- Snapshot of job configuration at the time of the job run required: - id - start_time - end_time - workspace_id - project_id - job_id - created_at - updated_at - type - status - payloads - successful_runs - failed_runs - job_configuration_snapshot results: type: object properties: signed_url: type: string signed_url_expiration: type: string size: type: number key: type: string format: type: string required: - signed_url - format required: - jobRun '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId /{workspaceId}/projects/{projectName}/jobs/{jobId}/runs/{jobRunId}/terminate: post: tags: - projects.jobs.runs summary: Terminate Job Run description: Terminate a JobRun by ID. operationId: terminateJobRun x-speakeasy-name-override: terminate parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: The ID you assigned when creating the Job. example: my-sample-job in: path name: jobId - schema: type: string required: true description: >- The JobRun ID. Get this from the list JobRuns endpoint or from the trigger Job response. example: jr_abc123def456ghi789xyz in: path name: jobRunId x-codeSamples: - lang: typescript label: terminateJobRun source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.jobs.runs.terminate( "my-project", "my-sample-job", "jr_abc123def456ghi789xyz", ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.jobs.runs.terminate( project_name="my-project", job_id="my-sample-job", job_run_id="jr_abc123def456ghi789xyz", ) print(res) responses: '200': description: JobRun terminated successfully. content: application/json: schema: type: object properties: message: type: string description: Success message confirming JobRun termination. example: JobRun terminated successfully. required: - message '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId /{workspaceId}/projects/{projectName}/auth-sessions: get: tags: - projects.authSessions summary: Get AuthSessions description: Get all AuthSessions in a Project. operationId: getAuthSessions x-speakeasy-name-override: all parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName x-codeSamples: - lang: typescript label: getAuthSessions source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.authSessions.all("my-project"); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.auth_sessions.list( project_name="my-project", ) print(res) responses: '200': description: List of AuthSessions content: application/json: schema: type: array items: type: object properties: id: type: string minLength: 3 pattern: ^[a-zA-Z0-9-(),_]+$ description: The unique identifier for the authentication session example: auth-session-123 type: type: string enum: - CREDENTIALS - RECORDER - RUNTIME status: type: string enum: - PENDING - READY - EXPIRED required: - id - type - status examples: success: summary: List of AuthSessions value: - id: auth-session-123 type: CREDENTIALS status: READY - id: auth-session-456 type: RUNTIME status: PENDING /{workspaceId}/projects/{projectName}/auth-sessions/{authSessionId}: get: tags: - projects.authSessions summary: Get AuthSession description: Get an AuthSession by ID. operationId: getAuthSession x-speakeasy-name-override: one parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: >- Authentication session ID. You can obtain it from the AuthSessions tab in your project details. in: path name: authSessionId x-codeSamples: - lang: typescript label: getAuthSession source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.authSessions.one( "my-project", "", ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.auth_sessions.get( project_name="my-project", auth_session_id="auth-session-123", ) print(res) responses: '200': description: AuthSession details content: application/json: schema: type: object properties: id: type: string minLength: 3 pattern: ^[a-zA-Z0-9-(),_]+$ description: The unique identifier for the authentication session example: auth-session-123 type: type: string enum: - CREDENTIALS - RECORDER - RUNTIME status: type: string enum: - PENDING - READY - EXPIRED required: - id - type - status examples: success: summary: AuthSession details value: id: auth-session-123 type: CREDENTIALS status: READY delete: tags: - projects.authSessions summary: Delete AuthSession description: Delete an AuthSession by ID. operationId: deleteAuthSession x-speakeasy-name-override: delete parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: >- Authentication session ID. You can obtain it from the AuthSessions tab in your project details. in: path name: authSessionId x-codeSamples: - lang: typescript label: deleteAuthSession source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { await client.projects.authSessions.delete( "my-project", "", ); console.log("Request completed successfully"); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: client.projects.auth_sessions.delete( project_name="my-project", auth_session_id="auth-session-123", ) print("Request completed successfully") responses: '204': description: Deleted successfully /{workspaceId}/projects/{projectName}/auth-sessions/{authSessionId}/validate/start: post: tags: - projects.authSessions.validate summary: Validate AuthSession - Start description: Start AuthSession validation. operationId: ValidateAuthSessionStart x-speakeasy-name-override: start parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: >- Authentication session ID. You can obtain it from the AuthSessions tab in your project details. in: path name: authSessionId x-codeSamples: - lang: typescript label: ValidateAuthSessionStart source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.authSessions.validate.start( "my-project", "", { autoRecreate: true, checkAttempts: 3, }, ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient from intuned_client import models import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.auth_sessions.validate.start( project_name="my-project", auth_session_id="auth-session-123", body=models.AuthSessionsValidateStartRequestBody( autoRecreate=True, checkAttempts=3, createAttempts=3, ), ) print(res) requestBody: description: Validate AuthSession input schema required: true content: application/json: schema: type: object properties: autoRecreate: type: boolean default: true description: >- If true, the AuthSession will be automatically recreated if the check fails. example: true checkAttempts: type: integer default: 3 description: >- Number of attempts to check the validity of the AuthSession before recreating it. example: 3 createAttempts: type: integer default: 3 description: >- Number of attempts to create a new AuthSession if the current one is invalid or expired. example: 3 proxy: type: - string - 'null' format: uri description: >- Proxy URL to be used for the API call. This is optional and can be used to route the API call through a proxy server. Use "intuned://auto" to let the platform pick a proxy for this project. example: http://username:password@domain:port requestTimeout: type: integer default: 600 description: >- Timeout for the API request in seconds. Default is 10 minutes (600 seconds). example: 600 example: id: auth-session-123 checkAttempts: 3 createAttempts: 3 autoRecreate: true proxy: http://proxy.example.com:8080 responses: '201': description: Validate AuthSession operation started content: application/json: schema: type: object properties: status: type: string enum: - pending operationId: type: string required: - status - operationId examples: started: summary: Operation started value: status: pending operationId: aabbccddeeffggh /{workspaceId}/projects/{projectName}/auth-sessions/{authSessionId}/validate/{operationId}/result: get: tags: - projects.authSessions.validate summary: Validate AuthSession - Result description: Get AuthSession validation result. operationId: validateAuthSessionResult x-speakeasy-name-override: result parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: >- Authentication session ID. You can obtain it from the AuthSessions tab in your project details. in: path name: authSessionId - schema: type: string required: true description: The ID for the operation. This is obtained from the start request. example: aaaabbbCCCCdddd in: path name: operationId x-codeSamples: - lang: typescript label: validateAuthSessionResult source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.authSessions.validate.result( "my-project", "", "aaaabbbCCCCdddd", ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.auth_sessions.validate.result( project_name="my-project", auth_session_id="auth-session-123", operation_id="aaaabbbCCCCdddd", ) print(res) responses: '200': description: Get AuthSession validation result. content: application/json: schema: oneOf: - type: object properties: status: type: string enum: - done authSessionId: type: string minLength: 3 pattern: ^[a-zA-Z0-9-(),_]+$ description: The unique identifier for the authentication session example: auth-session-123 required: - status - authSessionId title: Done - type: object properties: status: type: string enum: - pending required: - status title: Pending - type: object properties: status: type: string enum: - canceled message: type: string reason: type: object properties: type: type: string enum: - auth-session-validate-dependency-failed - terminated - job-run-paused - job-run-terminated - failed-to-initialize-job-run - api-access-disabled - cancelled-user-action message: type: string doc_url: type: string description: Optional URL to documentation for this error example: >- https://intunedhq.com/docs/main/support/reasons#terminated details: {} required: - type - message required: - status - message - reason title: Canceled - type: object properties: status: type: string enum: - in_progress runId: type: string description: >- Unique identifier for the run, prefixed nanoId (ru_...) required: - status - runId title: In Progress - type: object properties: status: type: string enum: - failed message: type: string error: type: object properties: message: type: string description: Error message describing the failure example: An error occurred while executing the run code: type: string enum: - internal-server-error - script-process-crashed - unexpected - script-process-crashed - script-execution-exception - script-no-valid-output-received - result-too-big-error - script-timeout - script-unexpected-error - auth-check-failed - all-attempts-failed - check-attempts-failed - create-attempts-failed - post-create-check-attempts-failed - api-attempts-failed - onepassword-integration-error - job-run-terminated description: >- Optional error code for more specific error identification example: script-process-crashed category: type: string enum: - infrastructure - execution - auth - user - billing retirable: type: boolean default: false doc_url: type: string description: Optional URL to documentation for this error example: >- https://intunedhq.com/docs/main/support/errors#run-execution-error correlation_id: type: string description: >- Optional correlation ID for tracing the error in logs example: 123e4567-e89b-12d3-a456-426614174000 details: {} required: - message - category required: - status - message - error title: Failed examples: done: summary: Validation successful value: status: done authSessionId: auth-session-123 pending: summary: Operation pending value: status: pending /{workspaceId}/projects/{projectName}/auth-sessions/create: post: tags: - projects.authSessions.create summary: Create AuthSession - Start description: Start creating an AuthSession. operationId: CreateOrUpdateAuthSessionStart x-speakeasy-name-override: start parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName x-codeSamples: - lang: typescript label: CreateOrUpdateAuthSessionStart source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.authSessions.create.start( "my-project", { parameters: { "param1": "value1", "param2": 42, "param3": true }, }, ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient from intuned_client import models import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.auth_sessions.create.start( project_name="my-project", body=models.AuthSessionsCreateStartRequestBody( parameters={ "param1": "value1", "param2": 42, "param3": True, }, id="auth-session-123", proxy="http://username:password@proxy.example.com:8080", createAttempts=3, ), ) print(res) requestBody: description: Create AuthSession input schema required: true content: application/json: schema: type: object properties: id: type: string minLength: 3 pattern: ^[a-zA-Z0-9-(),_]+$ description: The unique identifier for the authentication session example: auth-session-123 parameters: type: object additionalProperties: true description: The parameters to be passed to the API. example: param1: value1 param2: 42 param3: true proxy: type: - string - 'null' format: uri description: Proxy configuration for the job example: http://username:password@proxy.example.com:8080 createAttempts: type: integer default: 3 description: >- Number of attempts to create a new AuthSession if the current one is invalid or expired. example: 3 checkAttempts: type: integer default: 3 description: >- Number of attempts to check the validity of the AuthSession before recreating it. example: 3 saveTrace: type: boolean required: - parameters example: parameters: username: john.doe password: password proxy: http://proxy.example.com:8080 createAttempts: 3 checkAttempts: 3 saveTrace: true requestTimeout: 60000 responses: '201': description: Create AuthSession operation started content: application/json: schema: type: object properties: status: type: string enum: - started operationId: type: string required: - status - operationId examples: started: summary: Operation started value: status: started operationId: aabbccddeeffggh /{workspaceId}/projects/{projectName}/auth-sessions/create/{operationId}/result: get: tags: - projects.authSessions.create summary: Create AuthSession - Result description: Get AuthSession creation result. operationId: createAuthSessionResult x-speakeasy-name-override: result parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: The ID for the operation. This is obtained from the start request. example: aaaabbbCCCCdddd in: path name: operationId x-codeSamples: - lang: typescript label: createAuthSessionResult source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.authSessions.create.result( "my-project", "aaaabbbCCCCdddd", ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.auth_sessions.create.result( project_name="my-project", operation_id="aaaabbbCCCCdddd", ) print(res) responses: '200': description: AuthSession creation result content: application/json: schema: oneOf: - type: object properties: status: type: string enum: - done authSessionId: type: string minLength: 3 pattern: ^[a-zA-Z0-9-(),_]+$ description: The unique identifier for the authentication session example: auth-session-123 required: - status - authSessionId title: Done - type: object properties: status: type: string enum: - pending required: - status title: Pending - type: object properties: status: type: string enum: - canceled message: type: string reason: type: object properties: type: type: string enum: - auth-session-validate-dependency-failed - terminated - job-run-paused - job-run-terminated - failed-to-initialize-job-run - api-access-disabled - cancelled-user-action message: type: string doc_url: type: string description: Optional URL to documentation for this error example: >- https://intunedhq.com/docs/main/support/reasons#terminated details: {} required: - type - message required: - status - message - reason title: Canceled - type: object properties: status: type: string enum: - in_progress runId: type: string description: >- Unique identifier for the run, prefixed nanoId (ru_...) required: - status - runId title: In Progress - type: object properties: status: type: string enum: - failed message: type: string error: type: object properties: message: type: string description: Error message describing the failure example: An error occurred while executing the run code: type: string enum: - internal-server-error - script-process-crashed - unexpected - script-process-crashed - script-execution-exception - script-no-valid-output-received - result-too-big-error - script-timeout - script-unexpected-error - auth-check-failed - all-attempts-failed - check-attempts-failed - create-attempts-failed - post-create-check-attempts-failed - api-attempts-failed - onepassword-integration-error - job-run-terminated description: >- Optional error code for more specific error identification example: script-process-crashed category: type: string enum: - infrastructure - execution - auth - user - billing retirable: type: boolean default: false doc_url: type: string description: Optional URL to documentation for this error example: >- https://intunedhq.com/docs/main/support/errors#run-execution-error correlation_id: type: string description: >- Optional correlation ID for tracing the error in logs example: 123e4567-e89b-12d3-a456-426614174000 details: {} required: - message - category required: - status - message - error title: Failed examples: done: summary: Operation completed value: status: done authSessionId: auth-session-123 pending: summary: Operation pending value: status: pending /{workspaceId}/projects/{projectName}/auth-sessions/{authSessionId}/update: post: tags: - projects.authSessions.update summary: Update AuthSession - Start description: Start updating an AuthSession. operationId: UpdateAuthSessionStart x-speakeasy-name-override: start parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: >- Authentication session ID. You can obtain it from the AuthSessions tab in your project details. in: path name: authSessionId x-codeSamples: - lang: typescript label: UpdateAuthSessionStart source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.authSessions.update.start( "my-project", "", { parameters: { "param1": "value1", "param2": 42, "param3": true }, }, ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient from intuned_client import models import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.auth_sessions.update.start( project_name="my-project", auth_session_id="auth-session-123", body=models.AuthSessionsUpdateStartRequestBody( parameters={ "param1": "value1", "param2": 42, "param3": True, }, proxy="http://username:password@proxy.example.com:8080", createAttempts=3, checkAttempts=3, ), ) print(res) requestBody: description: Update AuthSession input schema required: true content: application/json: schema: type: object properties: parameters: type: object additionalProperties: true description: The parameters to be passed to the API. example: param1: value1 param2: 42 param3: true proxy: type: - string - 'null' description: Proxy configuration for the job example: http://username:password@proxy.example.com:8080 createAttempts: type: integer default: 3 description: >- Number of attempts to create a new AuthSession if the current one is invalid or expired. example: 3 checkAttempts: type: integer default: 3 description: >- Number of attempts to check the validity of the AuthSession before recreating it. example: 3 saveTrace: type: boolean required: - parameters example: parameters: username: john.doe password: newPassword proxy: http://proxy.example.com:8080 createAttempts: 3 checkAttempts: 3 saveTrace: true responses: '201': description: Update AuthSession operation started content: application/json: schema: type: object properties: status: type: string enum: - started operationId: type: string required: - status - operationId examples: started: summary: Operation started value: status: started operationId: aabbccddeeffggh /{workspaceId}/projects/{projectName}/auth-sessions/{authSessionId}/update/{operationId}/result: get: tags: - projects.authSessions.update summary: Update AuthSession - Result description: Get AuthSession update result. operationId: updateAuthSessionResult x-speakeasy-name-override: result parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: The name you assigned when creating the Project. example: my-project in: path name: projectName - schema: type: string required: true description: >- Authentication session ID. You can obtain it from the AuthSessions tab in your project details. in: path name: authSessionId - schema: type: string required: true description: The ID for the operation. This is obtained from the start request. example: aaaabbbCCCCdddd in: path name: operationId x-codeSamples: - lang: typescript label: updateAuthSessionResult source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.projects.authSessions.update.result( "my-project", "", "aaaabbbCCCCdddd", ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.projects.auth_sessions.update.result( project_name="my-project", auth_session_id="auth-session-123", operation_id="aaaabbbCCCCdddd", ) print(res) responses: '200': description: AuthSession update result content: application/json: schema: oneOf: - type: object properties: status: type: string enum: - done authSessionId: type: string minLength: 3 pattern: ^[a-zA-Z0-9-(),_]+$ description: The unique identifier for the authentication session example: auth-session-123 required: - status - authSessionId title: Done - type: object properties: status: type: string enum: - pending required: - status title: Pending - type: object properties: status: type: string enum: - canceled message: type: string reason: type: object properties: type: type: string enum: - auth-session-validate-dependency-failed - terminated - job-run-paused - job-run-terminated - failed-to-initialize-job-run - api-access-disabled - cancelled-user-action message: type: string doc_url: type: string description: Optional URL to documentation for this error example: >- https://intunedhq.com/docs/main/support/reasons#terminated details: {} required: - type - message required: - status - message - reason title: Canceled - type: object properties: status: type: string enum: - in_progress runId: type: string description: >- Unique identifier for the run, prefixed nanoId (ru_...) required: - status - runId title: In Progress - type: object properties: status: type: string enum: - failed message: type: string error: type: object properties: message: type: string description: Error message describing the failure example: An error occurred while executing the run code: type: string enum: - internal-server-error - script-process-crashed - unexpected - script-process-crashed - script-execution-exception - script-no-valid-output-received - result-too-big-error - script-timeout - script-unexpected-error - auth-check-failed - all-attempts-failed - check-attempts-failed - create-attempts-failed - post-create-check-attempts-failed - api-attempts-failed - onepassword-integration-error - job-run-terminated description: >- Optional error code for more specific error identification example: script-process-crashed category: type: string enum: - infrastructure - execution - auth - user - billing retirable: type: boolean default: false doc_url: type: string description: Optional URL to documentation for this error example: >- https://intunedhq.com/docs/main/support/errors#run-execution-error correlation_id: type: string description: >- Optional correlation ID for tracing the error in logs example: 123e4567-e89b-12d3-a456-426614174000 details: {} required: - message - category required: - status - message - error title: Failed examples: done: summary: Operation completed value: status: done authSessionId: auth-session-123 pending: summary: Operation pending value: status: pending /{workspaceId}/web-tasks/start: post: tags: - webTasks summary: Web Task - Start description: >- Start a Web Task. The task runs asynchronously; poll the result endpoint for status and output. operationId: webTaskStart x-speakeasy-name-override: start parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true x-codeSamples: - lang: typescript label: webTaskStart source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.webTasks.start( { task: "Scrape YC companies from batch S24", }, ); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient from intuned_client import models import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.web_tasks.start( body=models.WebTasksStartRequestBody( task="Scrape YC companies from batch S24", startUrl="https://www.ycombinator.com/companies", parameters={ "param1": "value1", "param2": 42, "param3": True, }, outputSchema={ "key": "value", }, ), ) print(res) requestBody: description: Web Task input schema required: true content: application/json: schema: type: object properties: task: type: string description: Natural-language description of what to do. example: Scrape YC companies from batch S24 startUrl: type: string format: uri description: URL the agent should start from. example: https://www.ycombinator.com/companies parameters: type: object additionalProperties: true description: Free-form parameters substituted into the task at runtime. example: param1: value1 param2: 42 param3: true outputSchema: type: object description: >- Schema describing the expected output shape. Accepts JSON-Schema-shaped objects as well as Intuned's extended type vocabulary (e.g. `{ type: 'attachment' }`). additionalProperties: true x-intuned-schema-input: true reuseKey: type: string description: >- Caller-provided key that ties this task to a persisted code and resources tree. model: type: string enum: - haiku - sonnet - opus description: >- Anthropic model the agent should run with. Defaults to 'haiku' when omitted. example: sonnet proxy: type: string format: uri description: Proxy URL to use for all browser traffic in this task. example: http://my-proxy.com:8080 auth: type: string description: >- Id of a captured web task auth (recorder-based session). When set, the agent's browser is pre-loaded with that session's storage state so the task runs authenticated. example: wta_123 sink: oneOf: - type: object properties: type: type: string enum: - s3 bucket: type: string description: >- The name of the S3 bucket where the data will be stored. example: my-s3-bucket accessKeyId: type: string description: The access key ID for the S3 bucket. example: AKIAIOSFODNN7EXSSPLE secretAccessKey: type: string description: The secret access key for the S3 bucket. example: wJalrXUtnFFFI/K7MDENG/bPxRfiCYEXAMPLEKEY region: type: string description: The region where the S3 bucket is located. example: us-west-2 prefix: type: string description: >- Optional prefix for the S3 objects. This can be used to organize objects within the bucket. example: my-prefix/ skipOnFail: type: boolean default: false description: >- If enabled, failed payload runs will ***not*** be written to the bucket. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the S3 bucket. If not provided, all APIs will be sent. example: - api1 - api2 endpoint: type: string description: >- Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services. example: https://s3.custom-endpoint.com forcePathStyle: type: boolean description: >- If true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access. example: true required: - type - bucket - accessKeyId - secretAccessKey - region description: Configuration for the S3 sink. title: S3 Sink Configuration - type: object properties: type: type: string enum: - webhook url: type: string description: The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token skipOnFail: type: boolean default: false description: >- If true, the webhook will not be sent if the API execution fails. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the webhook. If not provided, all APIs will be sent. example: - api1 - api2 required: - type - url description: Configuration for the webhook sink. title: Webhook Sink Configuration description: >- Optional sink configuration. When set, the web task result is delivered to a webhook or S3 bucket once the task completes. Returned partially obfuscated in the result API response. required: - task description: >- Request body for POST /web-tasks/start. Stored verbatim in web_task.input. title: Web Task Start API Input example: task: Scrape YC companies from batch S24 startUrl: https://www.ycombinator.com/companies parameters: batch: S24 reuseKey: yc_companies example: task: Scrape YC companies from batch S24 startUrl: https://www.ycombinator.com/companies parameters: batch: S24 reuseKey: yc_companies responses: '200': description: Web task accepted and queued for execution. content: application/json: schema: type: object properties: webTaskId: type: string description: Unique web task id, prefixed nanoid (wt_...). example: wt_123 status: type: string enum: - pending required: - webTaskId - status title: Web Task Start API Response '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId /{workspaceId}/web-tasks/{webTaskId}/result: get: tags: - webTasks summary: Web Task - Result description: >- Get the status and result of a Web Task. The response is a discriminated union on `status`; the `completed` branch carries an `outcome` plus outcome-specific fields. operationId: webTaskResult x-speakeasy-name-override: result parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: Web Task ID. Returned from the start endpoint as `webTaskId`. example: wt_123 in: path name: webTaskId x-codeSamples: - lang: typescript label: webTaskResult source: | import { IntunedClient } from "@intuned/client"; const client = new IntunedClient({ workspaceId: "123e4567-e89b-12d3-a456-426614174000", apiKey: process.env["INTUNED_API_KEY"] ?? "", }); async function run() { const result = await client.webTasks.result("wt_123"); console.log(result); } run(); - lang: python label: Python (SDK) source: |- from intuned_client import IntunedClient import os with IntunedClient( workspace_id="123e4567-e89b-12d3-a456-426614174000", api_key=os.getenv("INTUNED_API_KEY", ""), ) as client: res = client.web_tasks.result( web_task_id="wt_123", ) print(res) responses: '200': description: Web task status and (when terminal) result envelope. content: application/json: schema: oneOf: - type: object properties: webTaskId: type: string description: Unique web task id, prefixed nanoid (wt_...). example: wt_123 createdAt: type: string format: date-time title: type: string input: type: object properties: task: type: string description: Natural-language description of what to do. example: Scrape YC companies from batch S24 startUrl: type: string format: uri description: URL the agent should start from. example: https://www.ycombinator.com/companies parameters: type: object additionalProperties: true description: >- Free-form parameters substituted into the task at runtime. example: param1: value1 param2: 42 param3: true outputSchema: type: object description: >- Schema describing the expected output shape. Accepts JSON-Schema-shaped objects as well as Intuned's extended type vocabulary (e.g. `{ type: 'attachment' }`). additionalProperties: true x-intuned-schema-input: true reuseKey: type: string description: >- Caller-provided key that ties this task to a persisted code and resources tree. model: type: string enum: - haiku - sonnet - opus description: >- Anthropic model the agent should run with. Defaults to 'haiku' when omitted. example: sonnet proxy: type: string format: uri description: >- Proxy URL to use for all browser traffic in this task. example: http://my-proxy.com:8080 auth: type: string description: >- Id of a captured web task auth (recorder-based session). When set, the agent's browser is pre-loaded with that session's storage state so the task runs authenticated. example: wta_123 sink: oneOf: - type: object properties: type: type: string enum: - s3 bucket: type: string description: >- The name of the S3 bucket where the data will be stored. example: my-s3-bucket accessKeyId: type: string description: The access key ID for the S3 bucket. example: AKIAIOSFODNN7EXSSPLE secretAccessKey: type: string description: The secret access key for the S3 bucket. example: wJalrXUtnFFFI/K7MDENG/bPxRfiCYEXAMPLEKEY region: type: string description: The region where the S3 bucket is located. example: us-west-2 prefix: type: string description: >- Optional prefix for the S3 objects. This can be used to organize objects within the bucket. example: my-prefix/ skipOnFail: type: boolean default: false description: >- If enabled, failed payload runs will ***not*** be written to the bucket. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the S3 bucket. If not provided, all APIs will be sent. example: - api1 - api2 endpoint: type: string description: >- Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services. example: https://s3.custom-endpoint.com forcePathStyle: type: boolean description: >- If true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access. example: true required: - type - bucket - accessKeyId - secretAccessKey - region description: Configuration for the S3 sink. title: S3 Sink Configuration - type: object properties: type: type: string enum: - webhook url: type: string description: >- The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token skipOnFail: type: boolean default: false description: >- If true, the webhook will not be sent if the API execution fails. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the webhook. If not provided, all APIs will be sent. example: - api1 - api2 required: - type - url description: Configuration for the webhook sink. title: Webhook Sink Configuration description: >- Sink the task was started with, returned partially obfuscated. required: - task description: >- Task input as submitted by the user via POST /web-tasks/start. title: Web Task Result Input example: task: Scrape YC companies from batch S24 startUrl: https://www.ycombinator.com/companies parameters: batch: S24 reuseKey: yc_companies status: type: string enum: - pending required: - webTaskId - createdAt - status - type: object properties: webTaskId: type: string description: Unique web task id, prefixed nanoid (wt_...). example: wt_123 createdAt: type: string format: date-time title: type: string input: type: object properties: task: type: string description: Natural-language description of what to do. example: Scrape YC companies from batch S24 startUrl: type: string format: uri description: URL the agent should start from. example: https://www.ycombinator.com/companies parameters: type: object additionalProperties: true description: >- Free-form parameters substituted into the task at runtime. example: param1: value1 param2: 42 param3: true outputSchema: type: object description: >- Schema describing the expected output shape. Accepts JSON-Schema-shaped objects as well as Intuned's extended type vocabulary (e.g. `{ type: 'attachment' }`). additionalProperties: true x-intuned-schema-input: true reuseKey: type: string description: >- Caller-provided key that ties this task to a persisted code and resources tree. model: type: string enum: - haiku - sonnet - opus description: >- Anthropic model the agent should run with. Defaults to 'haiku' when omitted. example: sonnet proxy: type: string format: uri description: >- Proxy URL to use for all browser traffic in this task. example: http://my-proxy.com:8080 auth: type: string description: >- Id of a captured web task auth (recorder-based session). When set, the agent's browser is pre-loaded with that session's storage state so the task runs authenticated. example: wta_123 sink: oneOf: - type: object properties: type: type: string enum: - s3 bucket: type: string description: >- The name of the S3 bucket where the data will be stored. example: my-s3-bucket accessKeyId: type: string description: The access key ID for the S3 bucket. example: AKIAIOSFODNN7EXSSPLE secretAccessKey: type: string description: The secret access key for the S3 bucket. example: wJalrXUtnFFFI/K7MDENG/bPxRfiCYEXAMPLEKEY region: type: string description: The region where the S3 bucket is located. example: us-west-2 prefix: type: string description: >- Optional prefix for the S3 objects. This can be used to organize objects within the bucket. example: my-prefix/ skipOnFail: type: boolean default: false description: >- If enabled, failed payload runs will ***not*** be written to the bucket. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the S3 bucket. If not provided, all APIs will be sent. example: - api1 - api2 endpoint: type: string description: >- Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services. example: https://s3.custom-endpoint.com forcePathStyle: type: boolean description: >- If true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access. example: true required: - type - bucket - accessKeyId - secretAccessKey - region description: Configuration for the S3 sink. title: S3 Sink Configuration - type: object properties: type: type: string enum: - webhook url: type: string description: >- The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token skipOnFail: type: boolean default: false description: >- If true, the webhook will not be sent if the API execution fails. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the webhook. If not provided, all APIs will be sent. example: - api1 - api2 required: - type - url description: Configuration for the webhook sink. title: Webhook Sink Configuration description: >- Sink the task was started with, returned partially obfuscated. required: - task description: >- Task input as submitted by the user via POST /web-tasks/start. title: Web Task Result Input example: task: Scrape YC companies from batch S24 startUrl: https://www.ycombinator.com/companies parameters: batch: S24 reuseKey: yc_companies status: type: string enum: - started startedAt: type: string format: date-time required: - webTaskId - createdAt - status - startedAt - type: object properties: webTaskId: type: string description: Unique web task id, prefixed nanoid (wt_...). example: wt_123 createdAt: type: string format: date-time title: type: string input: type: object properties: task: type: string description: Natural-language description of what to do. example: Scrape YC companies from batch S24 startUrl: type: string format: uri description: URL the agent should start from. example: https://www.ycombinator.com/companies parameters: type: object additionalProperties: true description: >- Free-form parameters substituted into the task at runtime. example: param1: value1 param2: 42 param3: true outputSchema: type: object description: >- Schema describing the expected output shape. Accepts JSON-Schema-shaped objects as well as Intuned's extended type vocabulary (e.g. `{ type: 'attachment' }`). additionalProperties: true x-intuned-schema-input: true reuseKey: type: string description: >- Caller-provided key that ties this task to a persisted code and resources tree. model: type: string enum: - haiku - sonnet - opus description: >- Anthropic model the agent should run with. Defaults to 'haiku' when omitted. example: sonnet proxy: type: string format: uri description: >- Proxy URL to use for all browser traffic in this task. example: http://my-proxy.com:8080 auth: type: string description: >- Id of a captured web task auth (recorder-based session). When set, the agent's browser is pre-loaded with that session's storage state so the task runs authenticated. example: wta_123 sink: oneOf: - type: object properties: type: type: string enum: - s3 bucket: type: string description: >- The name of the S3 bucket where the data will be stored. example: my-s3-bucket accessKeyId: type: string description: The access key ID for the S3 bucket. example: AKIAIOSFODNN7EXSSPLE secretAccessKey: type: string description: The secret access key for the S3 bucket. example: wJalrXUtnFFFI/K7MDENG/bPxRfiCYEXAMPLEKEY region: type: string description: The region where the S3 bucket is located. example: us-west-2 prefix: type: string description: >- Optional prefix for the S3 objects. This can be used to organize objects within the bucket. example: my-prefix/ skipOnFail: type: boolean default: false description: >- If enabled, failed payload runs will ***not*** be written to the bucket. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the S3 bucket. If not provided, all APIs will be sent. example: - api1 - api2 endpoint: type: string description: >- Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services. example: https://s3.custom-endpoint.com forcePathStyle: type: boolean description: >- If true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access. example: true required: - type - bucket - accessKeyId - secretAccessKey - region description: Configuration for the S3 sink. title: S3 Sink Configuration - type: object properties: type: type: string enum: - webhook url: type: string description: >- The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token skipOnFail: type: boolean default: false description: >- If true, the webhook will not be sent if the API execution fails. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the webhook. If not provided, all APIs will be sent. example: - api1 - api2 required: - type - url description: Configuration for the webhook sink. title: Webhook Sink Configuration description: >- Sink the task was started with, returned partially obfuscated. required: - task description: >- Task input as submitted by the user via POST /web-tasks/start. title: Web Task Result Input example: task: Scrape YC companies from batch S24 startUrl: https://www.ycombinator.com/companies parameters: batch: S24 reuseKey: yc_companies status: type: string enum: - completed outcome: type: string enum: - success - failed description: >- Public-facing outcome (lowercase). Present only when status='completed'. example: success startedAt: type: - string - 'null' format: date-time completedAt: type: string format: date-time reuse: type: object properties: key: type: string used: type: boolean created: type: boolean updated: type: boolean revision_id: type: string revision_timestamp: type: string format: date-time required: - key - used - updated - revision_id - revision_timestamp description: >- Per-execution snapshot of reuse-key state. Records the web_task that produced the resource revision observed by this run, plus whether this run created or updated the resource. cost: type: object properties: aiUsd: type: number minimum: 0 description: AI spend for this task in USD. example: 0.42 compute: type: object properties: unit: type: string enum: - hours description: Unit of `amount`. Always 'hours' for now. example: hours amount: type: number minimum: 0 description: Compute time consumed by the agent. example: 0.023 required: - unit - amount description: >- Compute portion of the cost surfaced to the caller. description: >- Public-facing cost summary returned only on completed web tasks. title: Web Task API Cost result: oneOf: - type: object properties: type: type: string enum: - inline data: description: >- Inline result body. Free-form JSON; conforms to the input.outputSchema when provided. required: - type description: >- Inline result envelope — small payload returned directly. - type: object properties: type: type: string enum: - file file: type: object properties: url: type: string format: uri description: Signed URL to download the result blob. contentType: type: string description: >- MIME type of the blob (e.g. application/json). example: application/json sizeBytes: type: integer minimum: 0 description: Size of the blob in bytes. expiresAt: type: string format: date-time description: Expiry of the signed URL (ISO-8601). required: - url - contentType - sizeBytes - expiresAt required: - type - file description: >- File result envelope — large payload offloaded to object storage and delivered via a signed URL. description: >- Public result envelope returned on completed+success. Discriminated by `type`: 'inline' carries `data`, 'file' carries a signed-URL `file` block. error: type: object properties: code: type: string enum: - workspace-rate-limited - unauthenticated - no-ai-credits-left - internal-error - timeout - rejected message: type: string details: {} required: - code - message description: Error info recorded for a FAILED web task. required: - webTaskId - createdAt - status - outcome - startedAt - completedAt - cost - type: object properties: webTaskId: type: string description: Unique web task id, prefixed nanoid (wt_...). example: wt_123 createdAt: type: string format: date-time title: type: string input: type: object properties: task: type: string description: Natural-language description of what to do. example: Scrape YC companies from batch S24 startUrl: type: string format: uri description: URL the agent should start from. example: https://www.ycombinator.com/companies parameters: type: object additionalProperties: true description: >- Free-form parameters substituted into the task at runtime. example: param1: value1 param2: 42 param3: true outputSchema: type: object description: >- Schema describing the expected output shape. Accepts JSON-Schema-shaped objects as well as Intuned's extended type vocabulary (e.g. `{ type: 'attachment' }`). additionalProperties: true x-intuned-schema-input: true reuseKey: type: string description: >- Caller-provided key that ties this task to a persisted code and resources tree. model: type: string enum: - haiku - sonnet - opus description: >- Anthropic model the agent should run with. Defaults to 'haiku' when omitted. example: sonnet proxy: type: string format: uri description: >- Proxy URL to use for all browser traffic in this task. example: http://my-proxy.com:8080 auth: type: string description: >- Id of a captured web task auth (recorder-based session). When set, the agent's browser is pre-loaded with that session's storage state so the task runs authenticated. example: wta_123 sink: oneOf: - type: object properties: type: type: string enum: - s3 bucket: type: string description: >- The name of the S3 bucket where the data will be stored. example: my-s3-bucket accessKeyId: type: string description: The access key ID for the S3 bucket. example: AKIAIOSFODNN7EXSSPLE secretAccessKey: type: string description: The secret access key for the S3 bucket. example: wJalrXUtnFFFI/K7MDENG/bPxRfiCYEXAMPLEKEY region: type: string description: The region where the S3 bucket is located. example: us-west-2 prefix: type: string description: >- Optional prefix for the S3 objects. This can be used to organize objects within the bucket. example: my-prefix/ skipOnFail: type: boolean default: false description: >- If enabled, failed payload runs will ***not*** be written to the bucket. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the S3 bucket. If not provided, all APIs will be sent. example: - api1 - api2 endpoint: type: string description: >- Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services. example: https://s3.custom-endpoint.com forcePathStyle: type: boolean description: >- If true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access. example: true required: - type - bucket - accessKeyId - secretAccessKey - region description: Configuration for the S3 sink. title: S3 Sink Configuration - type: object properties: type: type: string enum: - webhook url: type: string description: >- The URL to which the webhook will send the data. example: https://example.com/webhook headers: type: object additionalProperties: type: string description: >- Optional headers to be sent with the webhook request. example: Content-Type: application/json Authorization: Bearer token skipOnFail: type: boolean default: false description: >- If true, the webhook will not be sent if the API execution fails. apisToSend: type: array items: type: string minItems: 1 description: >- List of API names to be sent to the webhook. If not provided, all APIs will be sent. example: - api1 - api2 required: - type - url description: Configuration for the webhook sink. title: Webhook Sink Configuration description: >- Sink the task was started with, returned partially obfuscated. required: - task description: >- Task input as submitted by the user via POST /web-tasks/start. title: Web Task Result Input example: task: Scrape YC companies from batch S24 startUrl: https://www.ycombinator.com/companies parameters: batch: S24 reuseKey: yc_companies status: type: string enum: - canceled startedAt: type: - string - 'null' format: date-time completedAt: type: string format: date-time required: - webTaskId - createdAt - status - startedAt - completedAt description: >- Polled status + result envelope for GET /web-tasks/result/{webTaskId}. Discriminated by status; the 'completed' branch carries outcome plus outcome-specific fields (result/resultUrl on success, error on failure). title: Web Task Result API Response examples: pending: value: webTaskId: wt_123 status: pending createdAt: '2026-05-19T12:00:00.000Z' started: value: webTaskId: wt_123 status: started createdAt: '2026-05-19T12:00:00.000Z' startedAt: '2026-05-19T12:00:05.000Z' completedSuccessInline: value: webTaskId: wt_123 status: completed outcome: success createdAt: '2026-05-19T12:00:00.000Z' startedAt: '2026-05-19T12:00:05.000Z' completedAt: '2026-05-19T12:01:00.000Z' cost: aiUsd: 0.42 result: type: inline data: companies: - name: Acme completedFailed: value: webTaskId: wt_123 status: completed outcome: failed createdAt: '2026-05-19T12:00:00.000Z' startedAt: '2026-05-19T12:00:05.000Z' completedAt: '2026-05-19T12:01:00.000Z' cost: aiUsd: 0.05 error: code: internal-error message: Agent crashed before producing a result. canceled: value: webTaskId: wt_123 status: canceled createdAt: '2026-05-19T12:00:00.000Z' startedAt: '2026-05-19T12:00:05.000Z' completedAt: '2026-05-19T12:00:30.000Z' '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId /{workspaceId}/agent/start: post: tags: - agent summary: Intuned Agent - Start description: >- Start an autonomous Intuned Agent session on a project. `project.create` is required: set it to true to create a new project (409 if the name is already taken; you may also pass project.longName/tags/language) or false to run on an existing project (404 if it doesn't exist). Runs asynchronously — poll the status/result endpoints. operationId: agentStart x-speakeasy-name-override: start parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true requestBody: description: Intuned Agent session start input. required: true content: application/json: schema: type: object properties: message: type: string minLength: 1 description: Initial prompt for the Intuned Agent. example: >- Scrape all YC companies from batch S24 and return name + url. model: type: string enum: - sonnet - opus - haiku default: sonnet description: >- LLM the Intuned Agent runs with: sonnet (default), opus, or haiku. Defaults to sonnet when omitted. example: sonnet project: oneOf: - type: object properties: create: type: boolean enum: - true description: >- Create a new project. Fails with 409 if a project with this name already exists. Required to pass longName/tags/language. name: type: string minLength: 1 maxLength: 200 pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ description: Name for the new project. Must not already exist. example: yc-companies-scraper longName: type: string description: >- Human-friendly name / source URL for a newly created project. example: https://www.ycombinator.com/companies tags: type: array items: type: string minLength: 1 description: Tags to attach to a newly created project. example: - api - scraping language: type: string enum: - typescript - python description: >- Scaffolding language for a newly created project (defaults to typescript). example: typescript required: - create - name additionalProperties: false title: Project (create if missing) - type: object properties: create: type: boolean enum: - false description: >- Run on an existing project. Fails with 404 if no project with this name exists. name: type: string minLength: 1 maxLength: 200 pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ description: >- Existing project name. Must already exist in the workspace. example: yc-companies-scraper required: - create - name additionalProperties: false title: Project agentConfig: type: object properties: merge: type: boolean deploy: type: boolean required: - merge - deploy description: >- Deterministic end-of-session behavior. merge:true merges the branch when the Intuned Agent completes its work; deploy:true deploys after merge. No sign-off gate. title: Agent Config example: merge: true deploy: false required: - message - project - agentConfig additionalProperties: false title: Start Agent Session Input examples: New project: summary: Create the project if it doesn't exist value: message: Scrape YC companies from batch S24. model: sonnet project: create: true name: yc-companies-scraper language: typescript tags: - api agentConfig: merge: true deploy: false Existing project: summary: Edit an existing project value: message: Add pagination support. project: create: false name: yc-companies-scraper agentConfig: merge: true deploy: false responses: '200': description: Intuned Agent session started. content: application/json: schema: type: object properties: id: type: string format: uuid description: The Intuned Agent session id. status: type: string enum: - IN_PROGRESS required: - id - status title: Start Agent Session Response '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '409': description: Conflict content: application/json: schema: type: object properties: code: type: string enum: - conflict description: >- The request conflicts with the current state of the resource externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#conflict category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId /{workspaceId}/agent/{id}/result: get: tags: - agent summary: Intuned Agent - Result description: >- Get the result of an Intuned Agent session. `result` is null until the session completes; poll until it is populated. operationId: agentResult x-speakeasy-name-override: result parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: Agent session ID. Returned from the start endpoint as `id`. example: b3f1c2e4-1234-5678-9abc-def012345678 in: path name: id responses: '200': description: Intuned Agent session result (or null while still running). content: application/json: schema: type: object properties: id: type: string format: uuid status: type: string enum: - NOT_ACTIVE - IN_PROGRESS - AWAITING_USER_ACTION - COMPLETED - ARCHIVED description: Polled lifecycle status of the Intuned Agent session. result: type: - object - 'null' properties: project: type: object properties: id: type: string format: uuid name: type: string state: type: string required: - id - name - state title: Agent Result Project merged: type: boolean deployed: type: boolean workSummary: type: - string - 'null' sampleData: type: object properties: downloadUrl: type: string format: uri expiresAt: type: string format: date-time required: - downloadUrl - expiresAt title: Agent Session Sample Data required: - project - merged - deployed - workSummary description: >- The Intuned Agent's result. Null until the session completes; poll until populated. title: Agent Session Result required: - id - status - result description: >- Result for GET /agent/{id}/result. Mints the staging download URL when present. `result` is null until status is COMPLETED. title: Get Agent Session Result Response '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId /{workspaceId}/agent/{id}/resume: put: tags: - agent summary: Intuned Agent - Resume description: Re-wake a stopped Intuned Agent session so it continues running. operationId: agentResume x-speakeasy-name-override: resume parameters: - schema: type: string format: uuid required: true description: >- Your workspace ID. [How to find it](https://intunedhq.com/docs/main/03-how-to/manage/manage-workspace#how-to-get-your-workspace-id)? example: 123e4567-e89b-12d3-a456-426614174000 in: path name: workspaceId x-speakeasy-globals-hidden: true - schema: type: string required: true description: Agent session ID. Returned from the start endpoint as `id`. example: b3f1c2e4-1234-5678-9abc-def012345678 in: path name: id responses: '200': description: Session re-woken. content: application/json: schema: type: object properties: id: type: string format: uuid status: type: string enum: - IN_PROGRESS required: - id - status title: Resume Agent Session Response '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string enum: - bad-request description: The request is invalid or malformed externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#bad-request category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: string enum: - unauthorized description: The request requires user authentication externalDocs: description: Find more info here url: >- https://intunedhq.com/docs/main/support/errors#unauthorized category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '404': description: Not Found content: application/json: schema: type: object properties: code: type: string enum: - not-found description: The requested resource was not found externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#not-found category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId '409': description: Conflict content: application/json: schema: type: object properties: code: type: string enum: - conflict description: >- The request conflicts with the current state of the resource externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#conflict category: type: string enum: - user description: Errors caused by user actions or input externalDocs: description: Find more info here url: https://intunedhq.com/docs/main/support/errors#user message: type: string retirable: type: boolean enum: - false details: {} correlationId: type: string required: - code - category - message - retirable - correlationId x-speakeasy-globals: parameters: - $ref: '#/components/parameters/WorkspaceId'