Get the operation catalogue

GET

api

authoring

catalogue

curl --request GET \
  --url https://dev.simforge.ai/api/v1/authoring/catalogue \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dev.simforge.ai/api/v1/authoring/catalogue', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "schema": "simforge.authoring-operations/v1",
  "operations": [
    {
      "id": "<string>",
      "summary": "<string>",
      "inputSchema": {},
      "resultSchema": {},
      "effectCategory": "document",
      "requiredContext": [
        "<string>"
      ],
      "diagnostics": [
        "<unknown>"
      ],
      "applicability": "<unknown>"
    }
  ]
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Response

Workspace-bound authoring receipt.

schema

enum<string>

required

Available options:

simforge.authoring-operations/v1

operations

object[]

required

Show child attributes

{key}

any

Get the operation catalogue

curl --request GET \
  --url https://dev.simforge.ai/api/v1/authoring/catalogue \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dev.simforge.ai/api/v1/authoring/catalogue', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "schema": "simforge.authoring-operations/v1",
  "operations": [
    {
      "id": "<string>",
      "summary": "<string>",
      "inputSchema": {},
      "resultSchema": {},
      "effectCategory": "document",
      "requiredContext": [
        "<string>"
      ],
      "diagnostics": [
        "<unknown>"
      ],
      "applicability": "<unknown>"
    }
  ]
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

Cloud API

Endpoints

Get the operation catalogue

Authorizations

Response