Meta tags:
description=Overview of Onyx APIs;
keywords=onyx ai, onyx, open source ai, enterprise ai, generative ai platform, enterprise search, ai assistant, knowledge management, danswer;

Headings (most frequently used words):

api, reference, overview, auth, documentation, index, on, this, page, authentication, and, playground, next, steps, core, concepts, guide, send, chat, message, getting, started, guides, examples, miscellaneous, keys, personal, access, tokens,

Text of the page (most frequently used words):
api (27), onyx (24), and (18), the (13), access (11), keys (10), chat (9), use (9), can (9), with (7), your (7), token (7), endpoints (7), documentation (6), #overview (6), #reference (5), https (5), cloud (5), you (5), all (5), user (5), search (5), admin (5), are (4), this (4), concepts (4), page (4), for (4), app (4), tokens (4), cases (4), auth (4), built (3), core (3), message (3), apis (3), key (3), bearer (3), create (3), days (3), personal (3), permissions (3), actions (3), agents (3), management (3), authentication (3), getting (3), started (3), index (3), assistant (2), hosted (2), send (2), next (2), steps (2), explorer (2), com (2), docs (2), have (2), each (2), follow (2), guides (2), playground (2), any (2), from (2), accounts (2), settings (2), sessions (2), authorization (2), only (2), pats (2), requests (2), what (2), see (2), limited (2), scope (2), specific (2), read (2), basic (2), complete (2), admins (2), will (2), miscellaneous (2), ingestion (2), files (2), connectors (2), curator (2), responses, generated, using, may, contain, mistakes, mintlify, developer, platform, powered, linkedin, twitter, github, yes, was, helpful, simple, example, sending, programmatically, guide, learn, fundamental, terminology, working, purely, not, fully, featured, client, ignore, tenant_id, parameter, domain, find, openapi, curated, subset, useful, experiment, one, our, view, audit, revoke, time, get, onyx_pat_, curl, header, displayed, once, creation, copy, immediately, store, securely, click, give, name, choose, expiration, 365, never, new, let, authenticate, themselves, unlike, inherit, own, role, they, exactly, setup, instructions, testing, requiring, minimal, highly, restricted, environments, agent, post, messages, but, cannot, history, most, users, should, application, development, recommended, running, workflows, creating, managing, implementing, functionality, building, applications, non, like, unrestricted, instance, caution, features, data, analytics, operations, full, system, administration, including, those, pre, fixed, there, three, types, created, panel, exists, distinct, meaning, trace, activity, keep, private, resources, follows, breaking, changes, indicated, major, version, increments, semver, self, make, rest, principles, json, request, response, formats, require, relatively, consistent, patterns, nearly, every, feature, accessible, through, contact, limits, projects, credentials, examples, discord, website, changelog, security, developers, deployment, navigation, dot, ask, home, moving, group, based, global, roles, removed, changing, upcoming, change, skip, main, content, file, discover, available, pages, before, exploring, further, fetch, llms, txt,

Text of the page (random words):
overview auth onyx documentation documentation index fetch the complete documentation index at llms txt use this file to discover all available pages before exploring further skip to main content upcoming change onyx is moving to group based permissions curator and global curator roles will be removed see what s changing onyx documentation home page search k ask assistant onyx dot app onyx onyx cloud onyx cloud search navigation getting started overview auth overview deployment admins developers security changelog website discord getting started overview auth core concepts guides examples send a message to onyx index files with the ingestion api create connectors api reference chat search agents actions connectors credentials projects files ingestion api user management token limits miscellaneous miscellaneous contact us on this page authentication api keys personal access tokens api reference and playground next steps getting started overview auth overview of onyx apis nearly every onyx feature is accessible through the onyx api onyx apis are built on rest principles with json request response formats all endpoints require authentication and follow relatively consistent patterns make api requests to https cloud onyx app api or https your self hosted onyx com api onyx follows semver 2 0 0 breaking changes will be indicated by major version increments authentication api keys api keys are created by admins from the admin panel each key exists as a distinct user in onyx meaning you can trace activity keep chat sessions private and scope resources to a specific key there are three types admin api keys can access all endpoints including those pre fixed with admin use cases full system administration user management operations data management and analytics complete access to all onyx features ️ use with caution admin keys have unrestricted access to your onyx instance basic api keys can access the non admin endpoints like search chat agents and actions use cases building chat applications implementing search functionality creating and managing agents running actions and workflows recommended most users should use basic api keys for application development limited api keys read only agent access can post messages to chat endpoints but cannot read chat history use cases highly restricted environments specific use cases requiring minimal permissions testing with limited scope see api keys for setup instructions personal access tokens personal access tokens pats let any user authenticate api requests as themselves unlike api keys pats inherit your own role and permissions so they can access exactly what you can to create a token go to settings accounts access and click create new token give it a name and choose an expiration 7 days 30 days 365 days or never your token is displayed only once at creation copy it immediately and store it securely use the token as a bearer token in the authorization header curl h authorization bearer onyx_pat_ https cloud onyx app api chat get user chat sessions you can view audit and revoke your tokens at any time from settings accounts access api reference and playground in the api reference we have curated a subset of useful onyx api endpoints you can experiment with the endpoints on each page or follow one of our guides you can find all onyx api endpoints in the built in openapi explorer https cloud onyx app api docs or https your onyx domain com api docs the explorer is purely for reference it is not a fully featured api client ignore the tenant_id parameter and use your api key as a bearer token next steps core concepts learn the fundamental concepts and terminology for working with onyx apis guide send a chat message simple example of sending a message programmatically was this page helpful yes no core concepts i github twitter linkedin powered by this documentation is built and hosted on mintlify a developer documentation platform assistant responses are generated using ai and may contain mistakes