Get agent guidance

GET/workspaces/{organizationId}/agent/guidance/{id}

Path parameters

organizationIdstringrequired

idstringrequired

Responses

200

Guidance pack

idstringrequired

organizationIdstringrequired

namestringrequired

scopestringrequired

Allowed:workspaceteamstatusstep

scopeKeystring | nullrequired

bodystringrequired

linksobject[] | nullrequired

Show properties

Array of object

labelstring

urlstringrequired

versionintegerrequired

createdBystring | nullrequired

updatedBystring | nullrequired

createdAtstringrequired

updatedAtstringrequired

404

Guidance pack not found

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*idpath*

Request

curl -X GET '/workspaces/string/agent/guidance/string' \
  -H 'Accept: application/json'

const response = await fetch("/workspaces/string/agent/guidance/string", {
  method: "GET",
  headers: {
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "/workspaces/string/agent/guidance/string",
    headers={
        "Accept": "application/json"
    },
)

Response

{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "scope": "workspace",
  "scopeKey": "string",
  "body": "string",
  "links": [
    {
      "label": "string",
      "url": "string"
    }
  ],
  "version": 0,
  "createdBy": "string",
  "updatedBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}