{"openapi":"3.1.0","info":{"title":"Atlan (BYOK) API","version":"0.1.0","description":"Atlan (BYOK) lets an AI assistant read your own Atlan data through the Atlan API with a key you supply (Atlan API token (a role with read access is enough)). Read-only: 9 tools (search_assets_by_type, search_assets_by_name, list_connections, list_glossary_terms, list_glossary_categories, list_assets_by_certificate, get_asset, list_glossaries, get_lineage). The BYOK key travels with each request,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-atlan.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-atlan/docs"},"termsOfService":"https://connectorbay.com/byok-atlan/terms"},"servers":[{"url":"https://byok-atlan.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-atlan/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/search_assets_by_type":{"post":{"operationId":"search_assets_by_type","summary":"Search active catalog assets of one type, for example Table, View, Column, Connection or AtlasGlossaryTerm, sorted by na","description":"Search active catalog assets of one type, for example Table, View, Column, Connection or AtlasGlossaryTerm, sorted by name. Use for \"List the tables in my Atlan catalog\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Your Atlan tenant name: the first part of the address you sign in at (acme for acme.atlan.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Tenant","type":"string"},"type_name":{"description":"Atlan asset type name, for example 'Table', 'View', 'Column', 'Schema', 'Database' or 'AtlasGlossaryTerm' (case-sensitive).","maxLength":100,"title":"Type Name","type":"string"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging (0 to 10000).","title":"Offset"},"size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 50).","title":"Size"}},"required":["tenant","type_name"],"title":"search_assets_by_typeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_assets_by_name":{"post":{"operationId":"search_assets_by_name","summary":"Search active catalog assets whose name matches the given words, across all types. Use for \"Find Atlan assets named orde","description":"Search active catalog assets whose name matches the given words, across all types. Use for \"Find Atlan assets named orders\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Your Atlan tenant name: the first part of the address you sign in at (acme for acme.atlan.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Tenant","type":"string"},"text":{"description":"Words to match in the asset name, for example 'orders'.","maxLength":200,"title":"Text","type":"string"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging (0 to 10000).","title":"Offset"},"size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 50).","title":"Size"}},"required":["tenant","text"],"title":"search_assets_by_nameArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_connections":{"post":{"operationId":"list_connections","summary":"List the data source connections (Snowflake, Postgres, dbt and so on) configured in Atlan. Use for \"Which data connectio","description":"List the data source connections (Snowflake, Postgres, dbt and so on) configured in Atlan. Use for \"Which data connections exist in Atlan\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Your Atlan tenant name: the first part of the address you sign in at (acme for acme.atlan.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Tenant","type":"string"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging (0 to 10000).","title":"Offset"},"size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 50).","title":"Size"}},"required":["tenant"],"title":"list_connectionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_glossary_terms":{"post":{"operationId":"list_glossary_terms","summary":"List active business glossary terms with name, description and certificate status. Use for \"What glossary terms are defi","description":"List active business glossary terms with name, description and certificate status. Use for \"What glossary terms are defined in Atlan\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Your Atlan tenant name: the first part of the address you sign in at (acme for acme.atlan.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Tenant","type":"string"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging (0 to 10000).","title":"Offset"},"size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 50).","title":"Size"}},"required":["tenant"],"title":"list_glossary_termsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_glossary_categories":{"post":{"operationId":"list_glossary_categories","summary":"List active business glossary categories with name and description. Use for \"What glossary categories exist in Atlan\".","description":"List active business glossary categories with name and description. Use for \"What glossary categories exist in Atlan\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Your Atlan tenant name: the first part of the address you sign in at (acme for acme.atlan.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Tenant","type":"string"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging (0 to 10000).","title":"Offset"},"size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 50).","title":"Size"}},"required":["tenant"],"title":"list_glossary_categoriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_assets_by_certificate":{"post":{"operationId":"list_assets_by_certificate","summary":"List active assets with a given certificate status: VERIFIED, DRAFT or DEPRECATED. Use for \"Which Atlan assets are certi","description":"List active assets with a given certificate status: VERIFIED, DRAFT or DEPRECATED. Use for \"Which Atlan assets are certified as verified\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Your Atlan tenant name: the first part of the address you sign in at (acme for acme.atlan.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Tenant","type":"string"},"certificate_status":{"description":"Certificate status to filter by.","enum":["VERIFIED","DRAFT","DEPRECATED"],"title":"Certificate Status","type":"string"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging (0 to 10000).","title":"Offset"},"size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 50).","title":"Size"}},"required":["tenant","certificate_status"],"title":"list_assets_by_certificateArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_asset":{"post":{"operationId":"get_asset","summary":"Get one catalog asset by GUID: type, status and its main attributes (name, qualified name, description, certificate stat","description":"Get one catalog asset by GUID: type, status and its main attributes (name, qualified name, description, certificate status). Use for \"Show the Atlan asset with GUID 5f2a1c3e-0000-4000-8000-000000000001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Your Atlan tenant name: the first part of the address you sign in at (acme for acme.atlan.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Tenant","type":"string"},"guid":{"description":"Asset GUID (a UUID) returned by the search tools.","maxLength":64,"title":"Guid","type":"string"}},"required":["tenant","guid"],"title":"get_assetArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_glossaries":{"post":{"operationId":"list_glossaries","summary":"List the business glossaries with name, qualified name, short description and language. Use for \"Which glossaries exist ","description":"List the business glossaries with name, qualified name, short description and language. Use for \"Which glossaries exist in Atlan\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Your Atlan tenant name: the first part of the address you sign in at (acme for acme.atlan.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Tenant","type":"string"}},"required":["tenant"],"title":"list_glossariesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_lineage":{"post":{"operationId":"get_lineage","summary":"List assets upstream or downstream of an asset (data lineage) up to a depth, with name, type and qualified name. Use for","description":"List assets upstream or downstream of an asset (data lineage) up to a depth, with name, type and qualified name. Use for \"What feeds the Atlan asset 5f2a1c3e-0000-4000-8000-000000000001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tenant":{"description":"Your Atlan tenant name: the first part of the address you sign in at (acme for acme.atlan.com).","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Tenant","type":"string"},"guid":{"description":"GUID of the asset to start from.","maxLength":64,"title":"Guid","type":"string"},"direction":{"description":"INPUT for upstream assets, OUTPUT for downstream assets.","enum":["INPUT","OUTPUT"],"title":"Direction","type":"string"},"depth":{"anyOf":[{"maximum":5,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"How many hops to follow (1 to 5).","title":"Depth"},"size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 50).","title":"Size"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip.","title":"Offset"}},"required":["tenant","guid","direction"],"title":"get_lineageArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}