FastGPTFastGPT

Get Chat Record Response Details

Fetch detailed workflow node execution data (responseData) for a specific AI assistant message by dataId.

Endpoint Overview

  • Method : GET
  • Path : /api/core/chat/record/getResData
  • Module : Chat / Chat Records
  • Authentication : Authorization: Bearer <apiKey>—Supports App API Key ( appId optional) and Personal API Key ( appId required); also supports authProxy team member proxy and outLinkAuthData share link (see API Getting Started )
  • Interactive Try-It-Out : Open in Scalar API Explorer (self-hosted instances: replace the origin with <instance>/apidoc/systemopenapi#tag/%E5%AF%B9%E8%AF%9D%E7%AE%A1%E7%90%86/GET/core/chat/record/getResData )

Description & Notes

Retrieve detailed Node.js execution data ( responseData ) for a specific AI message by dataId .

Request Parameters

Query Parameters

Shared Parameters Across Branches

FieldTypeRequiredDefaultConstraints & Description
chatIdstringNo-Chat ID. maxLength: 1024
dataIdstringYes-Chat record data ID

Mutually Exclusive Branches ( anyOf )

  • App Chat

Identify the conversation via appId . When both API Key and login session are supported, Authorization takes precedence over token/Cookie.

FieldTypeRequiredDefaultConstraints & Description
appIdstringYes-Application ID authenticated with the request header credentials allowed by this endpoint. pattern: ^[0-9a-fA-F]{24}$
sourceTypestring (enum)No-Session resource type associated with appId . Defaults to app ; pass the matching sourceType for assistant builder sessions. Allowed values: app , chatAgentHelper , workflowBuilder

Default Identity : Omit customUid and authProxy to execute using the team member identity associated with the credential.

Custom end user ( customUid ): Tag end users from your own system via customUid without changing the authenticating member or permissions. Passed as workflow userId and used to scope chat management.

FieldTypeRequiredDefaultConstraints & Description
customUidstringYes-Supported only for standard app API Key calls. Exact match against the external user ID ( outLinkUid , not tmbId ). Omit to keep full scope or pass to restrict reads, updates, and deletions (max 1024 chars, cannot be empty or null , does not change member identity). minLength: 1; maxLength: 1024

Proxy Team Member ( authProxy ): Act on behalf of another member in the same team via authProxy . Available only on personal API keys with authProxy enabled; mutually exclusive with customUid .

FieldTypeRequiredDefaultConstraints & Description
authProxystringYes-JSON-serialized proxy identity, e.g. {"tmbId":"member-id"} or {"username":"alice"}
  • Skill Debug Session

Identify the debug session via skillId (takes precedence over appId and ignores sourceType ), authenticated with allowed request header credentials.

FieldTypeRequiredDefaultConstraints & Description
skillIdstringYes-Skill Edit debug ID authenticated with allowed request header credentials. pattern: ^[0-9a-fA-F]{24}$
  • Share-Link Chat

Resolves the underlying app via outLinkAuthData , taking precedence over skillId and appId (ignoring sourceType ). Protected links still validate login cookies/tokens and never fall back to standard auth on failure.

FieldTypeRequiredDefaultConstraints & Description
outLinkAuthDatastringYes-JSON-serialized share-link auth payload containing shareId and outLinkUid . Overrides skillId and appId ; protected links still check login session cookies/tokens.
  • App API Key (no appId required)

When authorizing with an app-bound App API Key, omit appId and sourceType ; the server resolves the bound app with sourceType fixed to app . Personal keys and login sessions cannot omit appId , and an explicit appId does not override an App API Key binding.

Default Identity : Omit customUid and authProxy to execute using the team member identity associated with the credential.

Custom end user ( customUid ): Tag end users from your own system via customUid without changing the authenticating member or permissions. Passed as workflow userId and used to scope chat management.

FieldTypeRequiredDefaultConstraints & Description
customUidstringYes-Supported only for standard app API Key calls. Exact match against the external user ID ( outLinkUid , not tmbId ). Omit to keep full scope or pass to restrict reads, updates, and deletions (max 1024 chars, cannot be empty or null , does not change member identity). minLength: 1; maxLength: 1024

Request Examples

Replace YOUR_API_KEY and placeholder IDs before running. Self-hosted users should replace the base URL with <instance>/api .

cURL Example

curl --fail-with-body -X GET "https://cloud.fastgpt.io/api/core/chat/record/getResData?appId=68ad85a7463006c963799a05&dataId=string" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Schema & Examples

Successful /api/* calls return the standard FastGPT envelope { "code": 200, "statusText": "", "message": "", "data": ... } , where data matches the 200 schema below (when a payload schema is declared; otherwise refer to the status description for runtime data semantics).

HTTP 200

Successfully returned response details

Returns the standard FastGPT success envelope ( { "code": 200, "statusText": "", "message": "", "data": ... } ). The exact data payload schema is not declared in this OpenAPI contract; refer to the status description above or inspect runtime responses.

Edit on GitHub

Last updated

On this page

Put your business knowledge to work with AI

Import company documents and build accurate, reliable, traceable AI answers.