Memory

Server

Download schema

创建或执行projects · projectId · external context · query

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/projects/{projectId}/external-context/query

创建或执行projects · projectId · external context · query › path Parameters

projectId

string · required

创建或执行projects · projectId · external context · query › Request Body

QueryExternalContextRequest

connectionId

string · required

actionId

string · required

object · required

创建或执行projects · projectId · external context · query › Responses

请求成功

ExternalContextObservationResponse

ExternalContextObservation · required

POST/v1/projects/{projectId}/external-context/query

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/projects/:projectId/external-context/query \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "connectionId": "connectionId",
  "actionId": "actionId",
  "input": {
    "key": "string"
  }
}'

Example Request Body

{
  "connectionId": "connectionId",
  "actionId": "actionId",
  "input": {
    "key": "string"
  }
}

json

Example Responses

{
  "observation": {
    "id": "id",
    "projectId": "projectId",
    "connectionId": "connectionId",
    "actionId": "actionId",
    "lifecycleVersion": 0,
    "items": [
      {
        "id": "id",
        "title": "title",
        "text": "text",
        "externalId": "externalId",
        "externalURL": "externalURL",
        "version": "version"
      }
    ],
    "expiresAt": "expiresAt",
    "createdAt": "createdAt"
  }
}

json

application/json

获取projects · projectId · memory

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/projects/{projectId}/memory

获取projects · projectId · memory › path Parameters

projectId

string · required

获取projects · projectId · memory › Responses

请求成功

ProjectMemoryResponse

projectId

Identifier · required

ProjectMemoryEntry[] · required

lastRefreshedAt

ISO8601Timestamp

GET/v1/projects/{projectId}/memory

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/projects/:projectId/memory

Example Responses

{
  "projectId": "projectId",
  "entries": [
    {
      "id": "id",
      "workspaceId": "workspaceId",
      "projectId": "projectId",
      "kind": "identity",
      "key": "key",
      "title": "title",
      "content": "content",
      "confidence": 0,
      "status": "active",
      "source": {
        "kind": "project",
        "connectionId": "connectionId",
        "externalMemorySourceId": "externalMemorySourceId",
        "sourceId": "sourceId",
        "sessionId": "sessionId",
        "externalObjectType": "externalObjectType",
        "externalObjectId": "externalObjectId",
        "externalURL": "externalURL",
        "version": "version",
        "observedAt": "observedAt"
      },
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    }
  ],
  "lastRefreshedAt": "lastRefreshedAt"
}

json

application/json

创建或执行projects · projectId · memory · claims

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/projects/{projectId}/memory/claims

创建或执行projects · projectId · memory · claims › path Parameters

projectId

string · required

创建或执行projects · projectId · memory · claims › Request Body

GenericRequest

创建或执行projects · projectId · memory · claims › Responses

请求成功

GenericResponse

创建或执行projects · projectId · memory · codebase

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/projects/{projectId}/memory/codebase

创建或执行projects · projectId · memory · codebase › path Parameters

projectId

string · required

创建或执行projects · projectId · memory · codebase › Request Body

GenericRequest

创建或执行projects · projectId · memory · codebase › Responses

请求成功

GenericResponse

创建或执行projects · projectId · memory · conflicts · conflictId · resolve

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/projects/{projectId}/memory/conflicts/{conflictId}/resolve

创建或执行projects · projectId · memory · conflicts · conflictId · resolve › path Parameters

projectId

string · required

conflictId

string · required

创建或执行projects · projectId · memory · conflicts · conflictId · resolve › Request Body

GenericRequest

创建或执行projects · projectId · memory · conflicts · conflictId · resolve › Responses

请求成功

GenericResponse

创建或执行projects · projectId · memory · external sources

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/projects/{projectId}/memory/external-sources

创建或执行projects · projectId · memory · external sources › path Parameters

projectId

string · required

创建或执行projects · projectId · memory · external sources › Request Body

SaveExternalMemoryRequest

observationId

Identifier · required

itemIds

Identifier[] · required

confirmSourceBound

boolean · const · required

Const value:

创建或执行projects · projectId · memory · external sources › Responses

请求成功

SaveExternalMemoryResponse

ExternalMemorySource[] · required

POST/v1/projects/{projectId}/memory/external-sources

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/projects/:projectId/memory/external-sources \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "observationId": "observationId",
  "itemIds": [
    "string"
  ],
  "confirmSourceBound": true
}'

Example Request Body

{
  "observationId": "observationId",
  "itemIds": [
    "string"
  ],
  "confirmSourceBound": true
}

json

Example Responses

{
  "sources": [
    {
      "id": "id",
      "projectId": "projectId",
      "createdByUserId": "createdByUserId",
      "connectionId": "connectionId",
      "actionId": "actionId",
      "lifecycleVersion": 0,
      "externalId": "externalId",
      "title": "title",
      "externalURL": "externalURL",
      "version": "version",
      "contentHash": "contentHash",
      "status": "active",
      "chunkCount": 0,
      "savedAt": "savedAt",
      "updatedAt": "updatedAt"
    }
  ]
}

json

application/json

创建或执行projects · projectId · memory · search

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/projects/{projectId}/memory/search

创建或执行projects · projectId · memory · search › path Parameters

projectId

string · required

创建或执行projects · projectId · memory · search › Request Body

GenericRequest

创建或执行projects · projectId · memory · search › Responses

请求成功

GenericResponse

获取projects · projectId · memory · sources

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/projects/{projectId}/memory/sources

获取projects · projectId · memory · sources › path Parameters

projectId

string · required

获取projects · projectId · memory · sources › Responses

请求成功

ExternalMemorySourceListResponse

ExternalMemorySource[] · required

获取projects · projectId · memory · sources · sourceId

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/projects/{projectId}/memory/sources/{sourceId}

获取projects · projectId · memory · sources · sourceId › path Parameters

projectId

string · required

sourceId

string · required

获取projects · projectId · memory · sources · sourceId › Responses

请求成功

GenericResponse

删除projects · projectId · memory · sources · sourceId

DELETE

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/projects/{projectId}/memory/sources/{sourceId}

删除projects · projectId · memory · sources · sourceId › path Parameters

projectId

string · required

sourceId

string · required

删除projects · projectId · memory · sources · sourceId › Responses

删除成功

No data returned

创建或执行search · answer

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/search/answer

创建或执行search · answer › Request Body

WorkspaceMemoryAnswerRequest

query

string · required

locale

string · enum

Enum values:

zh-Hans

创建或执行search · answer › Responses

请求成功

WorkspaceMemoryAnswerResponse

query

string · required

status

string · enum · required

Enum values:

answered

no-evidence

answer

string · required

WorkspaceMemoryAnswerSource[] · required

generatedBy

string · enum · required

Enum values:

grounded-ai

extractive

获取search · sessions

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/search/sessions

获取search · sessions › query Parameters

q

string

获取search · sessions › Responses

请求成功

SessionSearchResponse

query

string · required

SessionSnapshot[] · required

GET/v1/search/sessions

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/search/sessions

Example Responses

{
  "query": "query",
  "sessions": [
    {
      "sessionId": "sessionId",
      "workspaceId": "workspaceId",
      "projectId": "projectId",
      "title": "title",
      "status": "ready",
      "captureMode": "microphone",
      "contentLanguage": "contentLanguage",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt",
      "completedAt": "completedAt",
      "archivedAt": "archivedAt",
      "lastSequence": 0,
      "snapshotRevision": 0,
      "participants": [
        {
          "id": "id",
          "displayName": "displayName",
          "isCapturing": true
        }
      ],
      "captureSource": {
        "deviceId": "deviceId",
        "platform": "ios",
        "label": "label"
      },
      "speakerAliases": {
        "key": "string"
      },
      "transcripts": [
        {
          "id": "id",
          "text": "text",
          "speakerId": "speakerId",
          "startedAt": "startedAt",
          "endedAt": "endedAt",
          "createdAt": "createdAt",
          "chunkId": "chunkId"
        }
      ],
      "artifacts": [
        {
          "id": "id",
          "kind": "mind-map",
          "title": "title",
          "revision": 0,
          "nodes": [
            {
              "id": "id",
              "kind": "mind-map",
              "title": "title",
              "body": "body",
              "owner": "owner",
              "due": "due",
              "workStatus": "todo",
              "parentId": "parentId",
              "position": {
                "x": 0,
                "y": 0
              },
              "confidence": 0,
              "sourceSegmentIds": [
                "string"
              ]
            }
          ],
          "updatedAt": "updatedAt",
          "status": "proposed"
        }
      ],
      "orchestration": {
        "revision": 0,
        "chiefOfStaffRole": "chief-of-staff",
        "agents": [
          {
            "role": "chief-of-staff",
            "capabilityPool": "planning",
            "status": "observing",
            "reason": "reason",
            "taskIds": [
              "string"
            ],
            "activatedAt": "activatedAt",
            "updatedAt": "updatedAt"
          }
        ],
        "tasks": [
          {
            "id": "id",
            "role": "chief-of-staff",
            "capabilityPool": "planning",
            "title": "title",
            "objective": "objective",
            "status": "queued",
            "revision": 0,
            "createdAt": "createdAt",
            "updatedAt": "updatedAt",
            "sourceSegmentIds": [
              "string"
            ],
            "outputBlockIds": [
              "string"
            ],
            "dependsOnTaskIds": [
              "string"
            ],
            "note": "note"
          }
        ],
        "updatedAt": "updatedAt"
      },
      "blocks": [
        {
          "id": "id",
          "family": "text",
          "type": "type",
          "title": "title",
          "body": "body",
          "revision": 0,
          "state": "proposed",
          "inference": "verified",
          "sources": [
            {
              "kind": "transcript",
              "segmentId": "segmentId",
              "excerpt": "excerpt"
            }
          ],
          "properties": {
            "key": "string"
          },
          "relationshipIds": [
            "string"
          ],
          "createdAt": "createdAt",
          "updatedAt": "updatedAt",
          "createdBy": {
            "agentRole": "chief-of-staff",
            "taskId": "taskId"
          },
          "compatibility": {
            "artifactId": "artifactId",
            "artifactKind": "mind-map",
            "artifactNodeId": "artifactNodeId"
          }
        }
      ],
      "relationships": [
        {
          "id": "id",
          "fromBlockId": "fromBlockId",
          "toBlockId": "toBlockId",
          "kind": "supports",
          "label": "label",
          "revision": 0,
          "sourceSegmentIds": [
            "string"
          ]
        }
      ],
      "composition": {
        "id": "id",
        "title": "title",
        "kind": "kind",
        "summary": "summary",
        "revision": 0,
        "status": "draft",
        "sections": [
          {
            "id": "id",
            "title": "title",
            "purpose": "purpose",
            "layout": "prose",
            "placements": [
              {
                "id": "id",
                "blockId": "blockId",
                "order": 0,
                "presentation": "prose",
                "column": 0,
                "emphasis": "quiet"
              }
            ]
          }
        ],
        "relationshipIds": [
          "string"
        ],
        "createdAt": "createdAt",
        "updatedAt": "updatedAt"
      },
      "workSet": {
        "id": "id",
        "projectId": "projectId",
        "sessionId": "sessionId",
        "primaryBlockId": "primaryBlockId",
        "compositionId": "compositionId",
        "status": "forming",
        "blockIds": [
          "string"
        ],
        "actionIds": [
          "string"
        ],
        "preparedAt": "preparedAt",
        "createdAt": "createdAt",
        "updatedAt": "updatedAt"
      },
      "suggestions": [
        {
          "id": "id",
          "title": "title",
          "rationale": "rationale",
          "rank": 0,
          "sourceBlockIds": [
            "string"
          ],
          "compositionId": "compositionId",
          "target": {
            "kind": "string",
            "capability": "capability",
            "destination": "destination"
          },
          "requiresConfirmation": true,
          "status": "suggested",
          "createdAt": "createdAt",
          "updatedAt": "updatedAt"
        }
      ]
    }
  ]
}

json

application/json

Work Actions