> ## Documentation Index > Fetch the complete documentation index at: https://docs.heliyos.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get the knowledge base > Returns the workspace your API key belongs to with its knowledge base: the business context, the four fixed texts and the custom entries, plus the workspace's profile (name, website, industry, time zone and address). Texts come back in full. Read this before you call **Update the knowledge base**, because that call replaces the knowledge base whole. To list the files your workers read, call **List files** with `kind=knowledge_base`. > [!NOTE] > > In the Heliyos MCP server: [`heliyos_knowledge_entries_delete`](https://docs.heliyos.ai/mcp/tools/knowledge-base-and-files#heliyos-knowledge-entries-delete), [`heliyos_knowledge_entries_set`](https://docs.heliyos.ai/mcp/tools/knowledge-base-and-files#heliyos-knowledge-entries-set), [`heliyos_knowledge_get`](https://docs.heliyos.ai/mcp/tools/knowledge-base-and-files#heliyos-knowledge-get), [`heliyos_knowledge_update`](https://docs.heliyos.ai/mcp/tools/knowledge-base-and-files#heliyos-knowledge-update). ## OpenAPI ````yaml /api-reference/openapi.json get /v1/auth/organizations/current openapi: 3.0.3 info: title: Heliyos API version: 1.0.0 description: >- The REST API for Heliyos, the AI operating system for revenue. Every request is scoped to the workspace that owns the API key. Responses are JSON in a `{ meta, data }` envelope; errors use `{ message, error: { code, message, details } }`. contact: name: Heliyos support email: soham@heliyos.ai url: https://www.heliyos.ai servers: - url: https://api-prod.heliyos.ai description: Production security: - bearerAuth: [] tags: - name: Workspace description: >- The workspace your API key belongs to, and the log of credits it has used. Every other call in this API is scoped to this workspace. - name: Schemas description: >- Objects are your record types: companies, people, deal pipelines and any custom objects you add. Each object has fields, and a field's type decides what its records can hold. - name: Records description: >- Records are the rows of an object (base schema): companies, people, deals and custom objects. A record holds field values keyed by the object's field keys and links to other records. - name: Timeline description: >- The AI-written timeline of a company, person or deal: summary entries Heliyos writes on a schedule. For the exact change history see Activities, and for emails and meetings see Interactions. - name: Activities description: >- The change history of records and tasks: who created, changed or deleted what, and when. People, workers and the system each appear as the actor on the changes they make. - name: Interactions description: >- Email threads and meetings synced from connected mailboxes and calendars, linked to the people and companies they involve. - name: Notes description: >- Free-text notes, optionally linked to records, tasks and interactions. Notes show up on the timeline of every record they are linked to, and workers read them as customer memory. - name: Tasks description: >- Work items for people and workers, optionally linked to records. A task can be assigned to people, to workers, or both, and workers can be started on it directly. - name: Workers and runs description: >- Workers are the AI teammates of your workspace (the API calls them agents). Define what each one does and what starts it, ask Heliyos to do work, and follow every run, its steps and the reviews it waits on. - name: Reviews description: >- Reviews keep the team in control of consequential work. When a worker wants to send an email, change a deal, book a meeting, act in a connected app or needs a person's answer, the action waits as a review until someone approves or rejects it. - name: Scouts description: >- Scouts watch companies and the web for events such as funding rounds, product launches, leadership changes or press coverage, and record each finding as a signal. A workspace Scout defines what to look for; company Scouts are its copies running on individual companies. - name: Signals description: >- Signals are what Scouts find: one event, such as a funding round or a new executive, with a summary, its sources and the company it is about. New signals are unread until you mark them read. - name: Watchlist description: >- The watchlist is the set of companies your workers monitor. Each watched company uses one Watcher from your plan: the workers keep it enriched, pull in its emails and meetings, and run Scouts on it. - name: Knowledge base description: >- What your workers know about the business: the business context, four fixed texts (products, pain points, value proposition, qualification criteria) and any custom entries your team adds. Workers read it on their next run. Files your workers read live under Files, with kind `knowledge_base`. - name: Files description: >- Knowledge base files that workers read, and files attached to records, tasks and other resources. The API calls them attachments. Uploading takes three calls: get an upload URL, send the bytes to it, then create the file. - name: Labels description: >- Label groups that sort your email threads, for example Intent or Pricing questions. Heliyos files each classified thread under a group, and each group holds the more specific labels it brings together. The API calls them classification labels. - name: Team description: >- The people in your workspace and their roles: joined members and pending invitations. Inviting someone sends them an email. - name: Notification settings description: >- Which workspace events send notification emails, how often, and to whom. There is one settings document per workspace, shared by everyone in it. paths: /v1/auth/organizations/current: get: tags: - Knowledge base summary: Get the knowledge base description: >- Returns the workspace your API key belongs to with its knowledge base: the business context, the four fixed texts and the custom entries, plus the workspace's profile (name, website, industry, time zone and address). Texts come back in full. Read this before you call **Update the knowledge base**, because that call replaces the knowledge base whole. To list the files your workers read, call **List files** with `kind=knowledge_base`. operationId: getCurrentOrganization parameters: [] responses: '200': description: The workspace profile and its knowledge base. content: application/json: schema: type: object required: - meta - data properties: meta: type: object required: - message properties: message: type: string description: A human-readable summary of the result. data: $ref: '#/components/schemas/WorkspaceProfile' example: meta: message: Organization Successfully Fetched. data: id: 66a0f1e2d3c4b5a697887766 _id: 66a0f1e2d3c4b5a697887766 name: Northwind Traders website: https://northwind.example.com industry: Wholesale distribution timezone: America/New_York businessContext: >- Northwind Traders supplies specialty food and beverage products to independent grocers and cafes across North America. knowledgeBase: productsInformation: >- Wholesale catalogue of 1,200 specialty foods, with next-day delivery in 40 metro areas. painPoints: >- Independent grocers lose margin to stockouts and juggle too many small suppliers. valueProposition: >- One supplier, one invoice and next-day restocking for the long tail of the shelf. qualificationCriteria: >- Independent grocers or cafe groups with 3 or more locations and a buyer we can reach. entries: - label: Pricing content: >- Volume pricing starts at $5,000 a month. Net 30 terms after the first order. - label: Competitors content: >- Regional distributors and direct-from-brand programs. We win on breadth and delivery speed. createdAt: '2024-07-24T09:15:00.000Z' updatedAt: '2026-11-02T14:30:00.000Z' '400': description: Validation failed content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: Unauthenticated content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': description: Rate limited content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: WorkspaceProfile: type: object description: >- The workspace's profile and knowledge base. The response also carries other workspace settings that this page does not document. Rely only on the fields listed here. properties: id: allOf: - $ref: '#/components/schemas/ObjectId' description: The workspace's id. _id: allOf: - $ref: '#/components/schemas/ObjectId' description: The same value as `id`. name: type: string description: The workspace's name. businessContext: type: string description: >- What the business does, in your team's words. Empty string when not set. knowledgeBase: $ref: '#/components/schemas/KnowledgeBase' website: type: string description: The company website. Absent when not set. industry: type: string description: The industry. Absent when not set. timezone: type: string description: The workspace's time zone. Absent when not set. address: type: string description: Street address. Absent when not set. city: type: string description: City. Absent when not set. state: type: string description: State or region. Absent when not set. zipcode: type: string description: Postal code. Absent when not set. country: type: string description: Country. Absent when not set. logo: type: string description: >- The logo, as a file id or the https URL of a file stored in Heliyos. Absent when not set. createdAt: $ref: '#/components/schemas/Timestamp' updatedAt: $ref: '#/components/schemas/Timestamp' ErrorEnvelope: type: object required: - message - error properties: message: type: string description: Same as error.message. error: type: object required: - code - message properties: code: type: string enum: - VALIDATION_FAILED - UNAUTHENTICATED - FORBIDDEN_ACTION - NOT_FOUND - RATE_LIMITED - CONFLICT - INTERNAL message: type: string details: {} ObjectId: type: string pattern: ^[0-9a-fA-F]{24}$ description: A 24-character hexadecimal id. example: 66f1a8c3e4b0a1b2c3d4e5f6 KnowledgeBase: type: object description: >- The knowledge base. Every text is plain text, Markdown or HTML and can be an empty string. Keys you stored that are not listed here are kept and returned as they are. properties: productsInformation: type: string description: The products and services you sell. painPoints: type: string description: The customer problems your products solve. valueProposition: type: string description: Why customers choose your products. qualificationCriteria: type: string description: What makes a lead worth pursuing. entries: type: array description: >- Your team's custom entries, in display order. Can be absent when the workspace has never saved one. items: $ref: '#/components/schemas/KnowledgeEntry' Timestamp: type: string format: date-time description: An ISO 8601 date-time in UTC. example: '2026-11-04T09:30:00.000Z' KnowledgeEntry: type: object description: >- A custom knowledge entry, for facts the fixed texts do not cover, such as pricing or competitors. properties: label: type: string description: The entry's title, for example `Pricing`. example: Pricing content: type: string description: >- The entry's content, as plain text or HTML. The Heliyos app edits it as rich text. example: >- Growth is $49 per seat per month, billed yearly. Annual contracts above 50 seats get 15% off. securitySchemes: bearerAuth: type: http scheme: bearer description: >- A workspace API key, sent as `Authorization: Bearer heliyos_...`. Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.