Get file metadata

GET

/api/v1/files/{file_id}

const url = 'https://api.inside.chat/api/v1/files/example?conversation_id=example&message_id=example&include_internal=false';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.inside.chat/api/v1/files/example?conversation_id=example&message_id=example&include_internal=false' \
  --header 'Authorization: Bearer <token>'

Required scopes: file_read, conversation_read, message_content_read, contact_read_pii
Data access: message_content, pii
MCP tool: file_get
Note: include_internal adds internal_notes_read

Read metadata for one file linked to an exact permitted conversation message. Requires all file/transcript grants and restrictions; internal messages need notes opt-in. Storage URLs and download/upload are unavailable.

Authorizations

installation_token
oauth_client_credentials
file_read conversation_read message_content_read contact_read_pii

Parameters

Path Parameters

file_id

required

string

/^fil_[0-9]{1,20}_[1-9][0-9]{0,18}_[1-9][0-9]{0,18}$/

Query Parameters

website_id

string

/^web_[0-9]{1,20}_[1-9][0-9]{0,18}$/

Optional; if present must match the resource owner.

conversation_id

required

string

<= 100 characters /^con_[0-9]{1,20}_[1-9][0-9]{0,18}_[1-9][0-9]{0,18}$/

message_id

required

string

<= 100 characters /^msg_[0-9]{1,20}_[1-9][0-9]{0,18}_[1-9][0-9]{0,18}$/

include_internal

Explicitly include stored internal messages. Requires internal_notes_read and the internal_notes data flag in addition to all transcript grants. Default is public messages only.

boolean

Responses

200

Authorized result. Projection depends on current scopes and data policy.

application/json

object

data

required

object

conversation_id

required

string

<= 100 characters /^con_[0-9]{1,20}_[1-9][0-9]{0,18}_[1-9][0-9]{0,18}$/

message_id

required

string

<= 100 characters /^msg_[0-9]{1,20}_[1-9][0-9]{0,18}_[1-9][0-9]{0,18}$/

visibility

required

string

Allowed values: public internal

file

required

object

required

string

<= 100 characters /^fil_[0-9]{1,20}_[1-9][0-9]{0,18}_[1-9][0-9]{0,18}$/

name

required

Any of:

string
null

string

<= 512 characters

content_type

required

string

<= 100 characters /^[a-z0-9][a-z0-9!#$&^_.+-]*/[a-z0-9][a-z0-9!#$&^_.+-]*$/

size_bytes

required

Any of:

string
null

string

<= 19 characters /^(?:0|[1-9][0-9]{0,18})$/

download_available

required

coverage

required

Allowed value: persisted_message_attachment_metadata

Example

{
  "data": {
    "visibility": "public",
    "download_available": false,
    "coverage": "persisted_message_attachment_metadata"
  }
}

400

Invalid, duplicate or unsupported request parameters.

401

Missing, expired or revoked installation credential.

404

Resource not found or not permitted by current authority.

422

The requested capability is not available for application installations.

429

Per-app quota exceeded.

Headers

Retry-After

integer

>= 1

503

Enrollment, native service or required authority is unavailable.