How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Brainfish Documents API

Document management operations including create, read, update, list, and delete

Brainfish Documents API is one of 9 APIs that Brainfish publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, authentication docs, and rate-limit docs.

This API exposes 8 operations across 5 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.brainfi.sh.

8 operations 5 paths 18 schemas 1 DELETE2 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.brainfi.sh
Authentication
HTTP Bearer, API Key, API Key
License
Proprietary
Resource Areas
1

Authentication & Security 3

Brainfish Documents API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (API Token) (BearerAuth). An API key is passed in the header as access-token (AccessToken). An API key is passed in the header as agent-key (AgentKey).

  • BearerAuth — Bearer token authentication. Include your API token in the Authorization header. Example: Authorization: Bearer bfapixxxxx Create tokens in your Brainfish dash…
  • AccessToken — Deprecated: Use Bearer authentication instead. Legacy access token header for backward compatibility. Must start with bfapi. Create tokens in your Brainfish da…
  • AgentKey — Agent key identifier that specifies which AI agent/widget to use for the request. Find agent keys in your Brainfish dashboard under Agents. Click on any agent…

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 2 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Documents 8

Document management operations including create, read, update, list, and delete

GET
/v1/documents
List documents
listDocuments 7 params → 200401429500
POST
/v1/documents
Create document
createDocument body → 200401422429500
GET
/v1/documents/{id}
Get document
getDocument 1 param → 200401404429500
PUT
/v1/documents/{id}
Update document
updateDocument 1 param body → 200401404422429500
DELETE
/v1/documents/{id}
Delete document
deleteDocument 2 params → 200401404429500
POST
/v1/documents/{id}/move
Move document
moveDocument 1 param body → 200401404422429500
POST
/v1/documents/search
Search documents
searchDocuments body → 200401422429500
POST
/v1/documents/suggestion
Generate article suggestions
generateArticleSuggestion body → 200401404409422429500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Document (21 properties), DocumentDetail (21 properties), DocumentListItem (19 properties), SearchResult (9 properties). Each schema is shown below with its type and property counts.

GenerateArticleSuggestionResponse
object
3 properties 3 required
Document
object
21 properties 3 required
DocumentListItem
object
Simplified document representation for list endpoints
19 properties 4 required
DeleteDocumentResponse
object
2 properties 2 required
SearchDocumentsRequest
object
6 properties 1 required
ValidationError
SearchResult
object
9 properties
GenerateArticleSuggestionRequest
object
3 properties 1 required
DocumentResponse
object
2 properties 2 required
CreateDocumentRequest
object
7 properties
UserSummary
object
3 properties
MoveDocumentRequest
object
3 properties 1 required
UpdateDocumentRequest
object
6 properties
DocumentListResponse
object
3 properties 3 required
MoveDocumentResponse
object
2 properties 2 required
DocumentDetail
object
Full document representation with text content
21 properties 5 required
Error
object
5 properties 2 required
SearchDocumentsResponse
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

brainfish-documents-api-openapi.yml Raw ↑

Other APIs Brainfish publishes across the network.

Brainfish Agents API
Brainfish Analytics API
Brainfish Authentication API
Brainfish Catalogs API
Brainfish Collections API
Brainfish Conversations API
Brainfish Sessions API
Brainfish Users API
Where this information came from

This is an independent, third-party profile of Brainfish Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.