Skip to content
merran
GitHubInstall

Merran documentation API & integrations

A file sent to the assistant

GET
/api/assistant/files/{fileId}
curl --request GET \
--url http://localhost:3000/api/assistant/files/4f1c2a9e7b3d5f6a8c0e1b2d \
--cookie merran.session_token=<merran.session_token>

A photo as JPEG, or a PDF. Only the person who sent it sees it, like their chats. A file never changes, so it can be kept for good. With an API key, it needs the assistant: read permission.

fileId
required
string

Example

4f1c2a9e7b3d5f6a8c0e1b2d

The file.

string format: binary

Not signed in.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
fields
object
key
additional properties
string

Example

{
"error": {
"code": "not_found",
"message": "There's nothing here.",
"fields": {
"name": "Give it a name."
}
}
}

Not allowed.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
fields
object
key
additional properties
string

Example

{
"error": {
"code": "not_found",
"message": "There's nothing here.",
"fields": {
"name": "Give it a name."
}
}
}

No such file of yours.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
fields
object
key
additional properties
string

Example

{
"error": {
"code": "not_found",
"message": "There's nothing here.",
"fields": {
"name": "Give it a name."
}
}
}

© 2026 Kyle Johnson. Documentation: CC BY 4.0. Merran: AGPL-3.0-or-later.