start_build_workflow

ArtificialIntelligenceApi.start_build_workflow(policy_id, role_id, workflow_type, action=None, start_build_workflow_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Start a policy build workflow or generate an upload URL

Starts IMPORT_POLICY or INGEST_CONTENT. Set action=generate_presigned_url to receive a PUT URL for the workflow file instead of starting the workflow. A policy may have at most two build workflows. Requires owner access.

Parameters:

  • policy_id (str) – (required)

  • role_id (str) – (required)

  • workflow_type (str) – Type of build workflow to start or for which to generate a presigned upload URL. (required)

  • action (str) – Set to generate_presigned_url to return a presigned upload URL instead of starting the workflow. Omit to start the workflow.

  • start_build_workflow_request (StartBuildWorkflowRequest)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

StartBuildWorkflowResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: POST /ai/reasoning-policies/{policy_id}/build-workflows

Success (HTTP 200)

Successfully started build workflow or generated presigned URL

Errors

HTTP 400

Invalid input

HTTP 500

Something went wrong at backend