Update report template

PUT

/api/v1/report-templates/{id}

const url = 'https://example.com/api/v1/report-templates/example?projectId=00000000-0000-0000-0000-000000000000';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"example","description":"example","userPrompt":"example","systemPrompt":{"mode":"append","content":"example"},"trigger":{"type":"always"},"model":"example","timeoutMs":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url 'https://example.com/api/v1/report-templates/example?projectId=00000000-0000-0000-0000-000000000000' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "userPrompt": "example", "systemPrompt": { "mode": "append", "content": "example" }, "trigger": { "type": "always" }, "model": "example", "timeoutMs": 1 }'

Parameters

Path Parameters

required

string

Query Parameters

projectId

required

Project scope. Required on scoped list and root-create operations; requests without a resolvable project are rejected with 400. There is no default project.

string

>= 1 characters

Example

00000000-0000-0000-0000-000000000000

Project scope. Required on scoped list and root-create operations; requests without a resolvable project are rejected with 400. There is no default project.

Request Body

application/json

object

name

string

description

string

userPrompt

string

systemPrompt

object

mode

required

string

Allowed values: append override

content

required

string

trigger

One of:

object

type

required

string

Allowed values: always

model

string | null

timeoutMs

integer | null

> 0

Responses

200

Success

application/json

object

_id

required

string

required

string

name

required

string

description

string

userPrompt

required

string

systemPrompt

object

mode

required

string

Allowed values: append override

content

required

string

trigger

One of:

object

type

required

string

Allowed values: always

model

string

timeoutMs

integer

> 0

createdAt

required

string | null format: date-time

updatedAt

string | null format: date-time

deletedAt

string | null format: date-time

projectId

required

string

Example

{
  "systemPrompt": {
    "mode": "append"
  },
  "trigger": {
    "type": "always"
  }
}

404

Report template not found