Look up a context item

curl --request POST \
  --url https://api.getmodus.com/api/v1/context/items/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contextType": "slack_channel_metadata",
  "dataPath": [
    "00000000-0000-4000-a000-000000000111",
    "T0123456",
    "C0123456"
  ],
  "contentProjection": {
    "fields": [
      "channelId",
      "channelName",
      "isPrivate"
    ]
  }
}
'

{
  "item": {
    "uid": "<string>",
    "contextType": "<string>",
    "dataPath": [
      "<string>"
    ],
    "content": {},
    "connectionId": "<string>",
    "selectionId": "<string>"
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "status": "INVALID_ARGUMENT",
    "message": "Invalid value for query parameter `pageSize`.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "status": "UNAUTHENTICATED",
    "message": "Missing or invalid access token.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "status": "PERMISSION_DENIED",
    "message": "Missing required scope(s) for this operation.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS",
    "info": {
      "missing": [
        "<required-scope>"
      ]
    }
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "status": "NOT_FOUND",
    "message": "Resource not found.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
  }
}

{
  "error": {
    "code": "CONFLICT",
    "status": "ALREADY_EXISTS",
    "message": "A resource with that identifier already exists.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
  }
}

{
  "error": {
    "code": "VALIDATION",
    "status": "INVALID_ARGUMENT",
    "message": "Updates that would revoke your own access are not allowed.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "status": "INTERNAL",
    "message": "An unexpected error occurred.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
  }
}

POST

api

context

items

lookup

curl --request POST \
  --url https://api.getmodus.com/api/v1/context/items/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contextType": "slack_channel_metadata",
  "dataPath": [
    "00000000-0000-4000-a000-000000000111",
    "T0123456",
    "C0123456"
  ],
  "contentProjection": {
    "fields": [
      "channelId",
      "channelName",
      "isPrivate"
    ]
  }
}
'

{
  "item": {
    "uid": "<string>",
    "contextType": "<string>",
    "dataPath": [
      "<string>"
    ],
    "content": {},
    "connectionId": "<string>",
    "selectionId": "<string>"
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "status": "INVALID_ARGUMENT",
    "message": "Invalid value for query parameter `pageSize`.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "status": "UNAUTHENTICATED",
    "message": "Missing or invalid access token.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "status": "PERMISSION_DENIED",
    "message": "Missing required scope(s) for this operation.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS",
    "info": {
      "missing": [
        "<required-scope>"
      ]
    }
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "status": "NOT_FOUND",
    "message": "Resource not found.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
  }
}

{
  "error": {
    "code": "CONFLICT",
    "status": "ALREADY_EXISTS",
    "message": "A resource with that identifier already exists.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
  }
}

{
  "error": {
    "code": "VALIDATION",
    "status": "INVALID_ARGUMENT",
    "message": "Updates that would revoke your own access are not allowed.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "status": "INTERNAL",
    "message": "An unexpected error occurred.",
    "requestId": "req_01HQ7K8ABCDEFGHIJKLMNOPQRS"
  }
}

Authorizations

Authorization

string

header

required

A Modus personal access token (modus_<orgUuid>_<prefix>_<secret>) or an OAuth 2.1 access token, sent as Authorization: Bearer <token>.

Body

application/json

contextType

string

required

Context type of the row to fetch (e.g. slack_channel_metadata).

Example:

"slack_channel_metadata"

dataPath

string[]

required

Hierarchical data path identifying the row. Full equality match against the row's data_path column.

Example:

[
  "00000000-0000-4000-a000-000000000111",
  "T0123456"
]

contentProjection

object

Optional JSONB projection applied at SQL time to shrink the payload. When omitted the full content column is returned.

Show child attributes

Response

item

object | null

required

The matched row, or null when no row in the caller's tenant matches the supplied (contextType, dataPath).

Show child attributes

List context items Get a context item

Connections

Context

Modus · Chat

Modus · Context

Modus · Conversations

Scopes

Scopes · Chat

Scopes · Context

Scopes · Conversations

Scopes · Memories

Scopes · Supervision

Suggestions

Tools

Usage

Users

Workflows

Workflows · Interfaces

Workflows · Runs

Modus · Runs

Runs · Streaming

Scopes · Runs

Look up a context item

Authorizations

Body

Response