Catalog

Get block

Get a block's fields, conditions, operations, tool schemas, and triggers. Unversioned types resolve to the newest visible version; the returned `id` identifies that version. Hidden or missing blocks return `404`. OAuth scope: `api:read`.

GET/api/v2/blocks/{blockId}

Get a block's fields, conditions, operations, tool schemas, and triggers. Unversioned types resolve to the newest visible version; the returned id identifies that version. Hidden or missing blocks return 404.

OAuth scope: api:read.

Authentication

Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their description.

Send X-API-Key in the request header.

Alternatively

Send a Sim OAuth access token in Authorization: Bearer. See OAuth authentication and scopes.

Authorization: Bearer YOUR_ACCESS_TOKEN

Required scopes: api:read

OAuth flows

json

{
  "authorizationCode": {
    "authorizationUrl": "https://www.sim.ai/api/auth/oauth2/authorize",
    "tokenUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "refreshUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "scopes": {
      "api:read": "Read your workspaces, workflows, files, tables, and logs",
      "api:write": "Read, create, change, run, and delete resources in your workspaces",
      "offline_access": "Stay signed in without asking again"
    }
  }
}

OAuth scope: api:read.

Path parameters

blockIdstringRequired

Block type identifier. An unversioned base type resolves to the newest visible version. The response echoes the resolved ID.

minLength: 1
maxLength: 255

Query parameters

workspaceIdstringRequired

Workspace whose integration allowlist, revealed preview blocks, and deployed custom blocks decide what this catalog contains.

minLength: 1
maxLength: 128

Responses

@layer base { .docs-root [data-docs-tab-panel][hidden] { display: block !important; } } .docs-root [data-docs-tabs-root] [role="tablist"], .docs-root [data-docs-tabs-select] { display: none; }

The block.

@layer base { .docs-root [data-docs-tab-panel][hidden] { display: block !important; } } .docs-root [data-docs-tabs-root] [role="tablist"], .docs-root [data-docs-tabs-select] { display: none; }

object

One block with its fields, operations, tools, and triggers.

1 field

dataobjectRequired

Response data.

25 fields

idstringRequired

Block type identifier, used as a workflow block’s type.

namestringRequired

Display name.

descriptionstringRequired

One-line summary of what the block does.

longDescriptionstring

Extended explanation, when the block has one.

categorystringRequired

Toolbar category: blocks, tools, or triggers.

integrationTypestring

Integration category, e.g. communication, databases.

sourcestringRequired

Block source: builtin for built-in blocks, or custom for workflows this workspace deployed as blocks.

enum: ["builtin","custom"]

authModestring

How the block authenticates: oauth, api_key, or bot_token.

triggerAllowedbooleanRequired

Whether the block declares itself usable as a trigger.

triggerCapablebooleanRequired

Whether the block can start a workflow — a trigger-category block, one declaring triggerAllowed, or one with trigger-mode fields.

triggerIdsarrayRequired

Identifiers of the triggers this block supports.

Schema details

Array itemstring

toolIdsarrayRequired

Built-in tools this block can run. Read a tool by its id for the full definition.

Schema details

Array itemstring

operationIdsarrayRequired

Operations this block exposes. Their fields and tools are on the block read.

Schema details

Array itemstring

previewbooleanRequired

Whether the block is unreleased and revealed only to this caller.

sunsetobject

Post-release lifecycle state. Absent for a block in normal support.

2 fields

statusstringRequired

legacy is superseded but supported; deprecated is slated for removal.

enum: ["legacy","deprecated"]

replacedBystring

Block type to migrate to, when one exists.

Additional properties are not allowed.

docsLinkstring

Sim documentation page for the integration.

tagsarrayRequired

Catalog tags, e.g. messaging, version-control.

Schema details

Array itemstring

bestPracticesstring

Authored guidance on using the block correctly.

inputSchemaarrayRequired

Configuration fields that apply regardless of the selected operation.

Schema details

Array itemobject

One configuration field on a block.

33 fields

idstringRequired

Field identifier, and the key its value is stored under.

typestringRequired

Editor control the field renders as, e.g. short-input.

titlestring

Human-readable label.

requiredboolean

Whether a value must always be supplied. A field required only under some configuration reports false and carries requiredWhen.

requiredWhenobject

Condition under which the field is required.

4 fields

fieldstringRequired

Sibling field id whose value decides this condition.

valuevalueRequired

Value, or set of accepted values, the named field must hold.

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the match: every value EXCEPT value.

andobject

A second clause that must hold as well.

3 fields

fieldstringRequired

Sibling field id for the second clause.

valuevalue

Value the second clause matches. Absent means "holds any value".

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the second clause.

Additional properties are not allowed.

descriptionstring

Authored explanation of the field.

placeholderstring

Placeholder shown in the editor.

modestring

Where the field renders: basic, advanced, both, trigger, or trigger-advanced.

hiddenboolean

Whether the field is hidden in the editor.

reactiveConditionobject

Credential-kind requirement for this field or option; inspect the selected credential before using it.

2 fields

watchFieldsarrayRequired

Credential selector fields; the first populated value identifies the credential.

Schema details

Array itemstring

requiredTypestringRequired

Credential kind required for this field or option to apply.

enum: ["oauth","service_account"]

Additional properties are not allowed.

conditionobject

Condition under which the field applies at all.

4 fields

fieldstringRequired

Sibling field id whose value decides this condition.

valuevalueRequired

Value, or set of accepted values, the named field must hold.

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the match: every value EXCEPT value.

andobject

A second clause that must hold as well.

3 fields

fieldstringRequired

Sibling field id for the second clause.

valuevalue

Value the second clause matches. Absent means "holds any value".

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the second clause.

Additional properties are not allowed.

optionsarray

Selectable options. Absent on fields whose options are fetched per workspace at edit time. A model field always carries its options, with hosted marking the models a hosted deployment runs without an author-supplied key.

Schema details

Array itemobject

5 fields

idstringRequired

Value stored when this option is selected.

labelstring

Human-readable option label.

reactiveConditionobject

Credential-kind requirement for this field or option; inspect the selected credential before using it.

2 fields

watchFieldsarrayRequired

Credential selector fields; the first populated value identifies the credential.

Schema details

Array itemstring

requiredTypestringRequired

Credential kind required for this field or option to apply.

enum: ["oauth","service_account"]

Additional properties are not allowed.

hasIconboolean

Whether the option renders with an icon. The icon itself is not published.

hostedboolean

Model options only: whether Sim runs the model with its own key on a hosted deployment, so no provider API key is needed for it.

Additional properties are not allowed.

minnumber

Minimum accepted numeric value.

maxnumber

Maximum accepted numeric value.

stepnumber

Increment for numeric controls.

integerboolean

Whether the numeric value must be a whole number.

rowsnumber

Visible row count for multi-line text.

passwordboolean

Whether the stored value is masked in the editor.

multiSelectboolean

Whether more than one option may be selected.

languagestring

Language of a code field.

generationTypestring

Kind of content AI assistance generates here.

serviceIdstring

OAuth service this credential field authenticates.

requiredScopesarray

OAuth scopes the credential selected here must carry.

Schema details

Array itemstring

mimeTypestring

MIME type filter applied to a file picker.

acceptedTypesstring

Accepted file extensions for an upload field.

multipleboolean

Whether more than one file may be supplied.

maxSizenumber

Maximum upload size in megabytes.

connectionDroppableboolean

Whether another block’s output can be dropped onto this field.

columnsarray

Column headings for a table field.

Schema details

Array itemstring

dependsOnvalue

Sibling fields this field is cleared by when they change.

Schema details

Any of

Option 1array

Schema details

Array itemstring

Option 2object

2 fields

allarray

Every listed field must hold a value.

Schema details

Array itemstring

anyarray

At least one listed field must hold a value.

Schema details

Array itemstring

Additional properties are not allowed.

canonicalParamIdstring

Shared key for a picker/manual-entry pair. Both fields write the same value, so supply exactly one of the pair.

defaultValuevalue

Value used when the field is left unset.

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4object

Schema details

Additional propertiesvalue

Member of an object-valued default. Shape varies by field type.

Option 5array

Schema details

Array itemvalue

Element of an array-valued default. Shape varies by field type.

hasComputedDefaultboolean

Whether the field derives its value from the block’s other values. The deriving function is not published.

Additional properties are not allowed.

operationInputSchemaobjectRequired

Configuration fields keyed by the operation that reveals them.

Schema details

Additional propertiesarray

Schema details

Array itemobject

One configuration field on a block.

33 fields

idstringRequired

Field identifier, and the key its value is stored under.

typestringRequired

Editor control the field renders as, e.g. short-input.

titlestring

Human-readable label.

requiredboolean

Whether a value must always be supplied. A field required only under some configuration reports false and carries requiredWhen.

requiredWhenobject

Condition under which the field is required.

4 fields

fieldstringRequired

Sibling field id whose value decides this condition.

valuevalueRequired

Value, or set of accepted values, the named field must hold.

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the match: every value EXCEPT value.

andobject

A second clause that must hold as well.

3 fields

fieldstringRequired

Sibling field id for the second clause.

valuevalue

Value the second clause matches. Absent means "holds any value".

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the second clause.

Additional properties are not allowed.

descriptionstring

Authored explanation of the field.

placeholderstring

Placeholder shown in the editor.

modestring

Where the field renders: basic, advanced, both, trigger, or trigger-advanced.

hiddenboolean

Whether the field is hidden in the editor.

reactiveConditionobject

Credential-kind requirement for this field or option; inspect the selected credential before using it.

2 fields

watchFieldsarrayRequired

Credential selector fields; the first populated value identifies the credential.

Schema details

Array itemstring

requiredTypestringRequired

Credential kind required for this field or option to apply.

enum: ["oauth","service_account"]

Additional properties are not allowed.

conditionobject

Condition under which the field applies at all.

4 fields

fieldstringRequired

Sibling field id whose value decides this condition.

valuevalueRequired

Value, or set of accepted values, the named field must hold.

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the match: every value EXCEPT value.

andobject

A second clause that must hold as well.

3 fields

fieldstringRequired

Sibling field id for the second clause.

valuevalue

Value the second clause matches. Absent means "holds any value".

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the second clause.

Additional properties are not allowed.

optionsarray

Schema details

Array itemobject

5 fields

idstringRequired

Value stored when this option is selected.

labelstring

Human-readable option label.

reactiveConditionobject

Credential-kind requirement for this field or option; inspect the selected credential before using it.

2 fields

watchFieldsarrayRequired

Credential selector fields; the first populated value identifies the credential.

Schema details

Array itemstring

requiredTypestringRequired

Credential kind required for this field or option to apply.

enum: ["oauth","service_account"]

Additional properties are not allowed.

hasIconboolean

Whether the option renders with an icon. The icon itself is not published.

hostedboolean

Model options only: whether Sim runs the model with its own key on a hosted deployment, so no provider API key is needed for it.

Additional properties are not allowed.

minnumber

Minimum accepted numeric value.

maxnumber

Maximum accepted numeric value.

stepnumber

Increment for numeric controls.

integerboolean

Whether the numeric value must be a whole number.

rowsnumber

Visible row count for multi-line text.

passwordboolean

Whether the stored value is masked in the editor.

multiSelectboolean

Whether more than one option may be selected.

languagestring

Language of a code field.

generationTypestring

Kind of content AI assistance generates here.

serviceIdstring

OAuth service this credential field authenticates.

requiredScopesarray

OAuth scopes the credential selected here must carry.

Schema details

Array itemstring

mimeTypestring

MIME type filter applied to a file picker.

acceptedTypesstring

Accepted file extensions for an upload field.

multipleboolean

Whether more than one file may be supplied.

maxSizenumber

Maximum upload size in megabytes.

connectionDroppableboolean

Whether another block’s output can be dropped onto this field.

columnsarray

Column headings for a table field.

Schema details

Array itemstring

dependsOnvalue

Sibling fields this field is cleared by when they change.

Schema details

Any of

Option 1array

Schema details

Array itemstring

Option 2object

2 fields

allarray

Every listed field must hold a value.

Schema details

Array itemstring

anyarray

At least one listed field must hold a value.

Schema details

Array itemstring

Additional properties are not allowed.

canonicalParamIdstring

Shared key for a picker/manual-entry pair. Both fields write the same value, so supply exactly one of the pair.

defaultValuevalue

Value used when the field is left unset.

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4object

Schema details

Additional propertiesvalue

Member of an object-valued default. Shape varies by field type.

Option 5array

Schema details

Array itemvalue

Element of an array-valued default. Shape varies by field type.

hasComputedDefaultboolean

Whether the field derives its value from the block’s other values. The deriving function is not published.

Additional properties are not allowed.

inputDefinitionsobjectRequired

Block-level input definitions, keyed by parameter name.

Schema details

Additional propertiesobject

3 fields

typestringRequired

Value type: string, number, boolean, json, array, or file.

descriptionstring

What the input means.

schemavalue

JSON-Schema-shaped structure for object and array inputs.

Additional properties are not allowed.

operationsobjectRequired

Operations the block exposes, keyed by operation id.

Schema details

Additional propertiesobject

6 fields

toolIdstring

Built-in tool that performs this operation.

toolNamestring

Display name of that tool.

descriptionstring

What the operation does.

inputsobjectRequired

Values this operation needs, excluding the ones the block supplies from its own block-level inputs.

Schema details

Additional propertiesobject

One value a block operation needs, from its tool or its block-level inputs.

7 fields

typestringRequired

Value type.

requiredboolean

Whether the value must be supplied.

visibilitystring

Source of the value in a workflow or Agent block: user-or-llm, user-only, llm-only, or hidden. A direct Run tool caller may supply non-hidden parameters; Sim supplies hidden ones.

descriptionstring

What the value means.

defaultvalue

Value used when this input is omitted.

itemsvalue

JSON-Schema-shaped constraints declared by the tool parameter.

schemavalue

JSON-Schema-shaped structure declared by the block input.

Additional properties are not allowed.

outputsobjectRequired

Fields the operation produces.

Schema details

Additional propertiesobject

One declared output field of a built-in tool.

7 fields

typestringRequired

Value type of the output field.

descriptionstring

What the field holds.

optionalboolean

Whether the field may be absent.

nullableboolean

Whether the field may be null.

propertiesobject

Members of an object-typed output, keyed by field name.

Schema details

Additional propertiesvalue

Nested output field, in this same shape.

itemsobject

Element shape of an array-typed output.

3 fields

typestringRequired

Element value type.

descriptionstring

What an element holds.

propertiesobject

Members of an object-typed element, keyed by field name.

Schema details

Additional propertiesvalue

Nested output field, in this same shape.

Additional properties are not allowed.

fileConfigobject

File metadata for a file-typed output.

2 fields

mimeTypestring

MIME type of the produced file.

extensionstring

File extension of the produced file.

Additional properties are not allowed.

inputSchemaarrayRequired

Configuration fields that appear when this operation is selected.

Schema details

Array itemobject

One configuration field on a block.

33 fields

idstringRequired

Field identifier, and the key its value is stored under.

typestringRequired

Editor control the field renders as, e.g. short-input.

titlestring

Human-readable label.

requiredboolean

Whether a value must always be supplied. A field required only under some configuration reports false and carries requiredWhen.

requiredWhenobject

Condition under which the field is required.

4 fields

fieldstringRequired

Sibling field id whose value decides this condition.

valuevalueRequired

Value, or set of accepted values, the named field must hold.

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the match: every value EXCEPT value.

andobject

A second clause that must hold as well.

3 fields

fieldstringRequired

Sibling field id for the second clause.

valuevalue

Value the second clause matches. Absent means "holds any value".

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the second clause.

Additional properties are not allowed.

descriptionstring

Authored explanation of the field.

placeholderstring

Placeholder shown in the editor.

modestring

Where the field renders: basic, advanced, both, trigger, or trigger-advanced.

hiddenboolean

Whether the field is hidden in the editor.

reactiveConditionobject

Credential-kind requirement for this field or option; inspect the selected credential before using it.

2 fields

watchFieldsarrayRequired

Credential selector fields; the first populated value identifies the credential.

Schema details

Array itemstring

requiredTypestringRequired

Credential kind required for this field or option to apply.

enum: ["oauth","service_account"]

Additional properties are not allowed.

conditionobject

Condition under which the field applies at all.

4 fields

fieldstringRequired

Sibling field id whose value decides this condition.

valuevalueRequired

Value, or set of accepted values, the named field must hold.

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the match: every value EXCEPT value.

andobject

A second clause that must hold as well.

3 fields

fieldstringRequired

Sibling field id for the second clause.

valuevalue

Value the second clause matches. Absent means "holds any value".

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the second clause.

Additional properties are not allowed.

optionsarray

Schema details

Array itemobject

5 fields

idstringRequired

Value stored when this option is selected.

labelstring

Human-readable option label.

reactiveConditionobject

Credential-kind requirement for this field or option; inspect the selected credential before using it.

2 fields

watchFieldsarrayRequired

Credential selector fields; the first populated value identifies the credential.

Schema details

Array itemstring

requiredTypestringRequired

Credential kind required for this field or option to apply.

enum: ["oauth","service_account"]

Additional properties are not allowed.

hasIconboolean

Whether the option renders with an icon. The icon itself is not published.

hostedboolean

Model options only: whether Sim runs the model with its own key on a hosted deployment, so no provider API key is needed for it.

Additional properties are not allowed.

minnumber

Minimum accepted numeric value.

maxnumber

Maximum accepted numeric value.

stepnumber

Increment for numeric controls.

integerboolean

Whether the numeric value must be a whole number.

rowsnumber

Visible row count for multi-line text.

passwordboolean

Whether the stored value is masked in the editor.

multiSelectboolean

Whether more than one option may be selected.

languagestring

Language of a code field.

generationTypestring

Kind of content AI assistance generates here.

serviceIdstring

OAuth service this credential field authenticates.

requiredScopesarray

OAuth scopes the credential selected here must carry.

Schema details

Array itemstring

mimeTypestring

MIME type filter applied to a file picker.

acceptedTypesstring

Accepted file extensions for an upload field.

multipleboolean

Whether more than one file may be supplied.

maxSizenumber

Maximum upload size in megabytes.

connectionDroppableboolean

Whether another block’s output can be dropped onto this field.

columnsarray

Column headings for a table field.

Schema details

Array itemstring

dependsOnvalue

Sibling fields this field is cleared by when they change.

Schema details

Any of

Option 1array

Schema details

Array itemstring

Option 2object

2 fields

allarray

Every listed field must hold a value.

Schema details

Array itemstring

anyarray

At least one listed field must hold a value.

Schema details

Array itemstring

Additional properties are not allowed.

canonicalParamIdstring

Shared key for a picker/manual-entry pair. Both fields write the same value, so supply exactly one of the pair.

defaultValuevalue

Value used when the field is left unset.

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4object

Schema details

Additional propertiesvalue

Member of an object-valued default. Shape varies by field type.

Option 5array

Schema details

Array itemvalue

Element of an array-valued default. Shape varies by field type.

hasComputedDefaultboolean

Whether the field derives its value from the block’s other values. The deriving function is not published.

Additional properties are not allowed.

toolsarrayRequired

Every built-in tool the block can run, with parameters and outputs.

Schema details

Array itemobject

A built-in tool with its declared parameters and outputs.

8 fields

idstringRequired

Registered tool identifier, including its version suffix.

namestringRequired

Display name.

descriptionstringRequired

What the tool does.

versionstring

Tool version.

hostedApiKeystringRequired

API-key hosting on this deployment: always, conditional for some parameter combinations, or none when Sim does not supply a key. Supply your own key only if the tool requires one. Self-hosted deployments report none for every tool.

enum: ["always","conditional","none"]

oauthobject

OAuth requirement, when the tool has one.

3 fields

requiredbooleanRequired

Whether the tool cannot run without an OAuth credential.

providerstringRequired

OAuth service the credential must authenticate.

requiredScopesarray

Scopes the credential must carry.

Schema details

Array itemstring

Additional properties are not allowed.

paramsobjectRequired

Parameters the tool accepts.

Schema details

Additional propertiesobject

One declared parameter of a built-in tool.

6 fields

typestringRequired

Parameter value type.

requiredboolean

Whether the parameter must be supplied.

visibilitystring

Source of the value in a workflow or Agent block: user-or-llm, user-only, llm-only, or hidden. A direct Run tool caller may supply non-hidden parameters; Sim supplies hidden ones.

descriptionstring

What the parameter means.

defaultvalue

Value used when the parameter is omitted.

itemsvalue

JSON-Schema-shaped constraints for structured params.

Additional properties are not allowed.

outputsobjectRequired

Fields the tool produces.

Schema details

Additional propertiesobject

One declared output field of a built-in tool.

7 fields

typestringRequired

Value type of the output field.

descriptionstring

What the field holds.

optionalboolean

Whether the field may be absent.

nullableboolean

Whether the field may be null.

propertiesobject

Members of an object-typed output, keyed by field name.

Schema details

Additional propertiesvalue

Nested output field, in this same shape.

itemsobject

Element shape of an array-typed output.

3 fields

typestringRequired

Element value type.

descriptionstring

What an element holds.

propertiesobject

Members of an object-typed element, keyed by field name.

Schema details

Additional propertiesvalue

Nested output field, in this same shape.

Additional properties are not allowed.

fileConfigobject

File metadata for a file-typed output.

2 fields

mimeTypestring

MIME type of the produced file.

extensionstring

File extension of the produced file.

Additional properties are not allowed.

triggersarrayRequired

Triggers the block can run on.

Schema details

Array itemobject

3 fields

idstringRequired

Trigger identifier.

outputsobjectRequired

Top-level fields the trigger event delivers.

Schema details

Additional propertiesobject

2 fields

typestringRequired

Value type of the output.

descriptionstring

What the output holds.

Additional properties are not allowed.

configFieldsobjectRequired

Fields that configure the trigger, keyed by field id.

Schema details

Additional propertiesobject

9 fields

typestringRequired

Editor control the field renders as.

requiredbooleanRequired

Whether a value must be supplied.

titlestring

Human-readable label.

descriptionstring

Authored explanation of the field.

placeholderstring

Placeholder shown in the editor.

defaultvalue

Value used when the field is left unset.

optionsarray

Selectable options.

Schema details

Array itemobject

3 fields

idstringRequired

Value stored when this option is selected.

labelstringRequired

Human-readable option label.

reactiveConditionobject

Credential-kind requirement for this field or option; inspect the selected credential before using it.

2 fields

watchFieldsarrayRequired

Credential selector fields; the first populated value identifies the credential.

Schema details

Array itemstring

requiredTypestringRequired

Credential kind required for this field or option to apply.

enum: ["oauth","service_account"]

Additional properties are not allowed.

reactiveConditionobject

Credential-kind requirement for this field or option; inspect the selected credential before using it.

2 fields

watchFieldsarrayRequired

Credential selector fields; the first populated value identifies the credential.

Schema details

Array itemstring

requiredTypestringRequired

Credential kind required for this field or option to apply.

enum: ["oauth","service_account"]

Additional properties are not allowed.

conditionobject

Condition under which the field applies.

4 fields

fieldstringRequired

Sibling field id whose value decides this condition.

valuevalueRequired

Value, or set of accepted values, the named field must hold.

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the match: every value EXCEPT value.

andobject

A second clause that must hold as well.

3 fields

fieldstringRequired

Sibling field id for the second clause.

valuevalue

Value the second clause matches. Absent means "holds any value".

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array

Schema details

Array itemvalue

Schema details

Any of

Option 1string

Option 2number

Option 3boolean

notboolean

Invert the second clause.

Additional properties are not allowed.

outputsobjectRequired

Fields the block produces.

Schema details

Additional propertiesobject

2 fields

typestringRequired

Value type of the output.

descriptionstring

What the output holds.

Additional properties are not allowed.

Response example 1

json

{
  "data": {
    "id": "slack",
    "name": "Slack",
    "description": "Send messages and read channels in Slack.",
    "category": "tools",
    "integrationType": "communication",
    "source": "builtin",
    "authMode": "oauth",
    "triggerAllowed": true,
    "triggerCapable": true,
    "triggerIds": [
      "slack_webhook"
    ],
    "toolIds": [
      "slack_message",
      "slack_canvas_read"
    ],
    "operationIds": [
      "send",
      "read"
    ],
    "preview": false,
    "docsLink": "https://docs.sim.ai/tools/slack",
    "tags": [
      "messaging"
    ],
    "inputSchema": [
      {
        "id": "operation",
        "type": "dropdown",
        "title": "Operation",
        "required": true,
        "options": [
          {
            "id": "send",
            "label": "Send message"
          },
          {
            "id": "read",
            "label": "Read messages"
          }
        ]
      }
    ],
    "operationInputSchema": {
      "send": [
        {
          "id": "text",
          "type": "long-input",
          "title": "Message",
          "required": true
        }
      ]
    },
    "inputDefinitions": {
      "channel": {
        "type": "string",
        "description": "Channel to post into."
      }
    },
    "operations": {
      "send": {
        "toolId": "slack_message",
        "toolName": "Slack Send Message",
        "description": "Send a message to a Slack channel.",
        "inputs": {
          "text": {
            "type": "string",
            "required": true,
            "description": "Message body."
          }
        },
        "outputs": {
          "ts": {
            "type": "string",
            "description": "Message timestamp."
          }
        },
        "inputSchema": [
          {
            "id": "text",
            "type": "long-input",
            "title": "Message",
            "required": true
          }
        ]
      }
    },
    "tools": [
      {
        "id": "slack_message",
        "name": "Slack Send Message",
        "description": "Send a message to a Slack channel.",
        "version": "1.0.0",
        "hostedApiKey": "none",
        "oauth": {
          "required": true,
          "provider": "slack",
          "requiredScopes": [
            "chat:write"
          ]
        },
        "params": {
          "text": {
            "type": "string",
            "required": true,
            "description": "Message body."
          }
        },
        "outputs": {
          "ts": {
            "type": "string",
            "description": "Message timestamp."
          }
        }
      }
    ],
    "triggers": [
      {
        "id": "slack_webhook",
        "outputs": {
          "text": {
            "type": "string",
            "description": "Message text."
          }
        },
        "configFields": {
          "channels": {
            "type": "short-input",
            "required": false,
            "title": "Channels"
          }
        }
      }
    ],
    "outputs": {
      "ts": {
        "type": "string",
        "description": "Message timestamp."
      }
    }
  }
}

Response headers

X-RateLimit-Limitinteger

Maximum requests allowed in the current window.

minimum: 0
maximum: 9007199254740991

X-RateLimit-Remaininginteger

Requests remaining in the current window.

minimum: 0
maximum: 9007199254740991

X-RateLimit-Resetstring

ISO 8601 timestamp when the current rate-limit window resets.

format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

The request is invalid. This includes a query parameter sent with no value (?limit=, ?search=), which is rejected rather than read as zero, empty, or the parameter default — omit the parameter instead.

@layer base { .docs-root [data-docs-tab-panel][hidden] { display: block !important; } } .docs-root [data-docs-tabs-root] [role="tablist"], .docs-root [data-docs-tabs-select] { display: none; }

object

Canonical error envelope returned by the public v2 API.

1 field

errorobjectRequired

Canonical error details.

3 fields

codestringRequired

Stable machine-readable error code.

messagestringRequired

Human-readable explanation of the error.

detailsvalue

Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.

Schema details

Any of

Option 1object

Machine-readable cause and optional context for an actionable 403 response.

1 field

codestringRequired

Stable cause code for an actionable 403 response.

enum: ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","SCIM_MANAGED_MEMBERSHIP"]

Additional propertiesvalue

Additional context for this refusal.

Option 2value

Other structured context defined by the specific error.

Additional properties are not allowed.

Example

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}

The API credential is missing or invalid.

@layer base { .docs-root [data-docs-tab-panel][hidden] { display: block !important; } } .docs-root [data-docs-tabs-root] [role="tablist"], .docs-root [data-docs-tabs-select] { display: none; }

object

Canonical error envelope returned by the public v2 API.

1 field

errorobjectRequired

Canonical error details.

3 fields

codestringRequired

Stable machine-readable error code.

messagestringRequired

Human-readable explanation of the error.

detailsvalue

Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.

Schema details

Any of

Option 1object

Machine-readable cause and optional context for an actionable 403 response.

1 field

codestringRequired

Stable cause code for an actionable 403 response.

enum: ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","SCIM_MANAGED_MEMBERSHIP"]

Additional propertiesvalue

Additional context for this refusal.

Option 2value

Other structured context defined by the specific error.

Additional properties are not allowed.

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}

The caller lacks the rights this operation requires. When the cause is one a caller can act on, error.details.code names it. A resource in a workspace the caller cannot reach at all answers 404 instead, so absence and denial are indistinguishable.

@layer base { .docs-root [data-docs-tab-panel][hidden] { display: block !important; } } .docs-root [data-docs-tabs-root] [role="tablist"], .docs-root [data-docs-tabs-select] { display: none; }

object

Canonical error envelope returned by the public v2 API.

1 field

errorobjectRequired

Canonical error details.

3 fields

codestringRequired

Stable machine-readable error code.

messagestringRequired

Human-readable explanation of the error.

detailsvalue

Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.

Schema details

Any of

Option 1object

Machine-readable cause and optional context for an actionable 403 response.

1 field

codestringRequired

Stable cause code for an actionable 403 response.

enum: ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","SCIM_MANAGED_MEMBERSHIP"]

Additional propertiesvalue

Additional context for this refusal.

Option 2value

Other structured context defined by the specific error.

Additional properties are not allowed.

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}

The requested resource was not found.

@layer base { .docs-root [data-docs-tab-panel][hidden] { display: block !important; } } .docs-root [data-docs-tabs-root] [role="tablist"], .docs-root [data-docs-tabs-select] { display: none; }

object

Canonical error envelope returned by the public v2 API.

1 field

errorobjectRequired

Canonical error details.

3 fields

codestringRequired

Stable machine-readable error code.

messagestringRequired

Human-readable explanation of the error.

detailsvalue

Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.

Schema details

Any of

Option 1object

Machine-readable cause and optional context for an actionable 403 response.

1 field

codestringRequired

Stable cause code for an actionable 403 response.

enum: ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","SCIM_MANAGED_MEMBERSHIP"]

Additional propertiesvalue

Additional context for this refusal.

Option 2value

Other structured context defined by the specific error.

Additional properties are not allowed.

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}

The caller exceeded the request rate limit.

@layer base { .docs-root [data-docs-tab-panel][hidden] { display: block !important; } } .docs-root [data-docs-tabs-root] [role="tablist"], .docs-root [data-docs-tabs-select] { display: none; }

object

Canonical error envelope returned by the public v2 API.

1 field

errorobjectRequired

Canonical error details.

3 fields

codestringRequired

Stable machine-readable error code.

messagestringRequired

Human-readable explanation of the error.

detailsvalue

Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.

Schema details

Any of

Option 1object

Machine-readable cause and optional context for an actionable 403 response.

1 field

codestringRequired

Stable cause code for an actionable 403 response.

enum: ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","SCIM_MANAGED_MEMBERSHIP"]

Additional propertiesvalue

Additional context for this refusal.

Option 2value

Other structured context defined by the specific error.

Additional properties are not allowed.

Example

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}

Response headers

Retry-Afterinteger

Seconds to wait before retrying, sent on 429 and 503. Add jitter rather than retrying at exactly this offset.

minimum: 0
maximum: 9007199254740991

An unexpected server error occurred.

@layer base { .docs-root [data-docs-tab-panel][hidden] { display: block !important; } } .docs-root [data-docs-tabs-root] [role="tablist"], .docs-root [data-docs-tabs-select] { display: none; }

object

Canonical error envelope returned by the public v2 API.

1 field

errorobjectRequired

Canonical error details.

3 fields

codestringRequired

Stable machine-readable error code.

messagestringRequired

Human-readable explanation of the error.

detailsvalue

Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.

Schema details

Any of

Option 1object

Machine-readable cause and optional context for an actionable 403 response.

1 field

codestringRequired

Stable cause code for an actionable 403 response.

enum: ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","SCIM_MANAGED_MEMBERSHIP"]

Additional propertiesvalue

Additional context for this refusal.

Option 2value

Other structured context defined by the specific error.

Additional properties are not allowed.

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}

A required service is temporarily unavailable. When present, Retry-After gives the minimum seconds to wait; add jitter before retrying. Check operation-specific guidance before repeating a change after an uncertain response.

@layer base { .docs-root [data-docs-tab-panel][hidden] { display: block !important; } } .docs-root [data-docs-tabs-root] [role="tablist"], .docs-root [data-docs-tabs-select] { display: none; }

object

Canonical error envelope returned by the public v2 API.

1 field

errorobjectRequired

Canonical error details.

3 fields

codestringRequired

Stable machine-readable error code.

messagestringRequired

Human-readable explanation of the error.

detailsvalue

Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.

Schema details

Any of

Option 1object

Machine-readable cause and optional context for an actionable 403 response.

1 field

codestringRequired

Stable cause code for an actionable 403 response.

enum: ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","SCIM_MANAGED_MEMBERSHIP"]

Additional propertiesvalue

Additional context for this refusal.

Option 2value

Other structured context defined by the specific error.

Additional properties are not allowed.

Example

{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}

Response headers

Retry-Afterinteger

Seconds to wait before retrying, sent on 429 and 503. Add jitter rather than retrying at exactly this offset.

minimum: 0
maximum: 9007199254740991

Suggest an edit

@layer base { .docs-root [data-docs-tab-panel][hidden] { display: block !important; } } .docs-root [data-docs-tabs-root] [role="tablist"], .docs-root [data-docs-tabs-select] { display: none; }

Request

curl --request GET 'https://www.sim.ai/api/v2/blocks/string?workspaceId=string' \
  --header 'X-API-Key: YOUR_API_KEY'

const response = await fetch("https://www.sim.ai/api/v2/blocks/string?workspaceId=string", {
  "method": "GET",
  "headers": {
    "X-API-Key": "YOUR_API_KEY"
  }
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const result = await response.json();

import requests

response = requests.request(
    "GET",
    "https://www.sim.ai/api/v2/blocks/string?workspaceId=string",
    headers={
  "X-API-Key": "YOUR_API_KEY"
},
)
response.raise_for_status()
result = response.json()

package main

import (
  "io"
  "net/http"
  "os"
)

func check(err error) {
  if err != nil { panic(err) }
}

func must[T any](value T, err error) T {
  check(err)
  return value
}

func main() {

  request := must(http.NewRequest("GET", "https://www.sim.ai/api/v2/blocks/string?workspaceId=string", nil))
  request.Header.Set("X-API-Key", "YOUR_API_KEY")
  response := must(http.DefaultClient.Do(request))
  defer response.Body.Close()
  if response.StatusCode >= 400 { panic(response.Status) }
  must(io.Copy(os.Stdout, response.Body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
  public static void main(String[] args) throws Exception {
    var builder = HttpRequest.newBuilder(URI.create("https://www.sim.ai/api/v2/blocks/string?workspaceId=string"));
    builder.header("X-API-Key", "YOUR_API_KEY");
    var request = builder.method("GET", HttpRequest.BodyPublishers.noBody()).build();
    var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofInputStream());
    try (var body = response.body()) {
      if (response.statusCode() >= 400) throw new IllegalStateException("HTTP " + response.statusCode());
      body.transferTo(System.out);
    }
  }
}

using System;
using System.IO;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://www.sim.ai/api/v2/blocks/string?workspaceId=string");
request.Headers.TryAddWithoutValidation("X-API-Key", "YOUR_API_KEY");
using var response = await client.SendAsync(request, HttpCompletionOption.ResponseHeadersRead);
response.EnsureSuccessStatusCode();
await response.Content.CopyToAsync(Console.OpenStandardOutput());

@layer base { .docs-root [data-docs-tab-panel][hidden] { display: block !important; } } .docs-root [data-docs-tabs-root] [role="tablist"], .docs-root [data-docs-tabs-select] { display: none; }

Response

{
  "data": {
    "id": "slack",
    "name": "Slack",
    "description": "Send messages and read channels in Slack.",
    "category": "tools",
    "integrationType": "communication",
    "source": "builtin",
    "authMode": "oauth",
    "triggerAllowed": true,
    "triggerCapable": true,
    "triggerIds": [
      "slack_webhook"
    ],
    "toolIds": [
      "slack_message",
      "slack_canvas_read"
    ],
    "operationIds": [
      "send",
      "read"
    ],
    "preview": false,
    "docsLink": "https://docs.sim.ai/tools/slack",
    "tags": [
      "messaging"
    ],
    "inputSchema": [
      {
        "id": "operation",
        "type": "dropdown",
        "title": "Operation",
        "required": true,
        "options": [
          {
            "id": "send",
            "label": "Send message"
          },
          {
            "id": "read",
            "label": "Read messages"
          }
        ]
      }
    ],
    "operationInputSchema": {
      "send": [
        {
          "id": "text",
          "type": "long-input",
          "title": "Message",
          "required": true
        }
      ]
    },
    "inputDefinitions": {
      "channel": {
        "type": "string",
        "description": "Channel to post into."
      }
    },
    "operations": {
      "send": {
        "toolId": "slack_message",
        "toolName": "Slack Send Message",
        "description": "Send a message to a Slack channel.",
        "inputs": {
          "text": {
            "type": "string",
            "required": true,
            "description": "Message body."
          }
        },
        "outputs": {
          "ts": {
            "type": "string",
            "description": "Message timestamp."
          }
        },
        "inputSchema": [
          {
            "id": "text",
            "type": "long-input",
            "title": "Message",
            "required": true
          }
        ]
      }
    },
    "tools": [
      {
        "id": "slack_message",
        "name": "Slack Send Message",
        "description": "Send a message to a Slack channel.",
        "version": "1.0.0",
        "hostedApiKey": "none",
        "oauth": {
          "required": true,
          "provider": "slack",
          "requiredScopes": [
            "chat:write"
          ]
        },
        "params": {
          "text": {
            "type": "string",
            "required": true,
            "description": "Message body."
          }
        },
        "outputs": {
          "ts": {
            "type": "string",
            "description": "Message timestamp."
          }
        }
      }
    ],
    "triggers": [
      {
        "id": "slack_webhook",
        "outputs": {
          "text": {
            "type": "string",
            "description": "Message text."
          }
        },
        "configFields": {
          "channels": {
            "type": "short-input",
            "required": false,
            "title": "Channels"
          }
        }
      }
    ],
    "outputs": {
      "ts": {
        "type": "string",
        "description": "Message timestamp."
      }
    }
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}

OpenAPI document ↗Download the specification

Authentication

Path parameters

Query parameters

Responses

200

Response example 1

Response headers

400

401

403

404

429

Response headers

500

503

Response headers