SEseqeralabs
agents

Create agent

Changed on

Creates an agent in a workspace.

post/agents

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Query parameters

workspaceIdinteger

Workspace numeric identifier

Request body

agentInstructionsstring required

Instructions the agent follows. Must not be blank

agentInstructionsTemplateIdstring nullable

Template the instructions were created from. Surrounding whitespace is trimmed, and a blank value is stored as null

descriptionstring nullable

Surrounding whitespace is trimmed, and a blank value is stored as null

githubAppCredentialIdstring nullable

GitHub App credential in the workspace the agent uses for repository access. Surrounding whitespace is trimmed, and a blank value is stored as null

namestring required

Agent name, unique in the workspace. Letters, digits, dashes and underscores only. Surrounding whitespace is trimmed

serviceAccountIdinteger required

Service account the agent runs as. It must be enabled, be a participant of the workspace, and have a workspace role that grants agent:execute (launch, maintain, admin or owner)

Response

OK

Changes

  • adab9fd613a4Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      added the pattern ^[A-Za-z0-9_-]+$ to the request property

    • warning

      the request property's maxLength was set to 50000

    • warning

      the request property's maxLength was set to 255

    • warning

      the request property's maxLength was set to 120

    • warning

      the request property's maxLength was set to 255

    • warning

      the request property's min was set to 1.00

    • info

      added the optional property / to the response with the status

    • info

      the / response's property pattern ^[A-Za-z0-9_-]+$ was added for the status

  • 0e1a1696f553Revision changes
    • info

      added the non-success response with the status