Skip to content
Aura

Put Deployment Instructions

PUT
/api/v1/deployments/{name}/instructions
curl --request PUT \
  --url https://aura-api-eu.strangeworks.com/api/v1/deployments/example/instructions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "content": "example" }'

Replace the deployment’s AGENTS.md.

Deployments are company-owned and their instructions change agent behaviour for everyone who seeds from them, so this is a company write — never reachable by a user talking to the agent.

Existing projects hold a copy and do not see this until something pulls it: POST /projects/{id}/agent-config/pull, or a checkout from this deployment. Projects created after this write get the new text at seed time.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
name
required
Name
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
AgentInstructionsRequest
object
content
required
Content
string
>= 1 characters
Examplegenerated
{
  "content": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
AgentInstructionsResponse

Echo of a stored write, so a caller sees exactly what took effect.

object
content
required
Content
string
Examplegenerated
{
  "content": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}