from metadata.sdk import configurefrom metadata.sdk.entities import APIEndpointsfrom metadata.generated.schema.api.data.createAPIEndpoint import CreateAPIEndpointRequestconfigure( host="https://your-company.getcollate.io/api", jwt_token="your-jwt-token")request = CreateAPIEndpointRequest( name="addPet", displayName="Add Pet", apiCollection="sample_api_service.pet", description="Add a new pet to the store", endpointURL="https://petstore3.swagger.io/#/pet/addPet", requestMethod="POST", requestSchema={ "schemaType": "JSON", "schemaFields": [ {"name": "id", "dataType": "INT", "description": "ID of pet"} ] })endpoint = APIEndpoints.create(request)print(f"Created: {endpoint.fullyQualifiedName.root}")
import java.net.URI;import org.openmetadata.schema.api.data.CreateAPIEndpoint;import org.openmetadata.schema.entity.data.APIEndpoint;import org.openmetadata.schema.type.APIRequestMethod;// client is an initialized OpenMetadataClient.CreateAPIEndpoint request = new CreateAPIEndpoint() .withName("addPet") .withDisplayName("Add Pet") .withApiCollection("sample_api_service.pet") .withDescription("Add a new pet to the store") .withEndpointURL(URI.create("https://petstore3.swagger.io/#/pet/addPet")) .withRequestMethod(APIRequestMethod.POST);APIEndpoint endpoint = client.apiEndpoints().create(request);
Create a new API endpoint entity with HTTP method, parameters, responses, owners, tags, and metadata within an API collection using the Collate REST API.
POST
/
v1
/
apiEndpoints
POST /v1/apiEndpoints
from metadata.sdk import configurefrom metadata.sdk.entities import APIEndpointsfrom metadata.generated.schema.api.data.createAPIEndpoint import CreateAPIEndpointRequestconfigure( host="https://your-company.getcollate.io/api", jwt_token="your-jwt-token")request = CreateAPIEndpointRequest( name="addPet", displayName="Add Pet", apiCollection="sample_api_service.pet", description="Add a new pet to the store", endpointURL="https://petstore3.swagger.io/#/pet/addPet", requestMethod="POST", requestSchema={ "schemaType": "JSON", "schemaFields": [ {"name": "id", "dataType": "INT", "description": "ID of pet"} ] })endpoint = APIEndpoints.create(request)print(f"Created: {endpoint.fullyQualifiedName.root}")
import java.net.URI;import org.openmetadata.schema.api.data.CreateAPIEndpoint;import org.openmetadata.schema.entity.data.APIEndpoint;import org.openmetadata.schema.type.APIRequestMethod;// client is an initialized OpenMetadataClient.CreateAPIEndpoint request = new CreateAPIEndpoint() .withName("addPet") .withDisplayName("Add Pet") .withApiCollection("sample_api_service.pet") .withDescription("Add a new pet to the store") .withEndpointURL(URI.create("https://petstore3.swagger.io/#/pet/addPet")) .withRequestMethod(APIRequestMethod.POST);APIEndpoint endpoint = client.apiEndpoints().create(request);
Create a new API endpoint within an API collection.
Body Parameters
string
required
Name of the API endpoint. Must be unique within the parent API collection.
string
required
Fully qualified name of the parent APICollection, for example sample_api_service.pet.
string
URL for the API endpoint, for example https://petstore3.swagger.io/#/pet/addPet.
string
HTTP request method: GET, POST, PUT, PATCH, or DELETE.
object
Schema describing the request body.
Show properties
string
Type of schema, for example JSON.
array
Array of field objects describing the schema.
Show properties
string
Name of the field.
string
Data type of the field, for example INT, STRING, OBJECT.
string
Description of the field.
object
Schema describing the response body.
Show properties
string
Type of schema, for example JSON.
array
Array of field objects describing the schema.
Show properties
string
Name of the field.
string
Data type of the field.
string
Description of the field.
string
Human-readable display name for the API endpoint.
string
Description of the API endpoint in Markdown format.
array
Array of owner references (users or teams) to assign to the API endpoint.
Show properties
string
UUID of the owner entity.
string
Type of owner entity, for example user, team.
string
Name of the owner entity.
array
Fully qualified names of the domains to assign for governance purposes.
array
Array of classification tags to apply to the API endpoint.
Show properties
string
required
Fully qualified name of the tag.
string
Type of label, for example Manual, Derived, Propagated.
string
State of the tag, for example Suggested, Confirmed.
object
Custom property values defined by your organization’s metadata schema.
POST /v1/apiEndpoints
from metadata.sdk import configurefrom metadata.sdk.entities import APIEndpointsfrom metadata.generated.schema.api.data.createAPIEndpoint import CreateAPIEndpointRequestconfigure( host="https://your-company.getcollate.io/api", jwt_token="your-jwt-token")request = CreateAPIEndpointRequest( name="addPet", displayName="Add Pet", apiCollection="sample_api_service.pet", description="Add a new pet to the store", endpointURL="https://petstore3.swagger.io/#/pet/addPet", requestMethod="POST", requestSchema={ "schemaType": "JSON", "schemaFields": [ {"name": "id", "dataType": "INT", "description": "ID of pet"} ] })endpoint = APIEndpoints.create(request)print(f"Created: {endpoint.fullyQualifiedName.root}")
import java.net.URI;import org.openmetadata.schema.api.data.CreateAPIEndpoint;import org.openmetadata.schema.entity.data.APIEndpoint;import org.openmetadata.schema.type.APIRequestMethod;// client is an initialized OpenMetadataClient.CreateAPIEndpoint request = new CreateAPIEndpoint() .withName("addPet") .withDisplayName("Add Pet") .withApiCollection("sample_api_service.pet") .withDescription("Add a new pet to the store") .withEndpointURL(URI.create("https://petstore3.swagger.io/#/pet/addPet")) .withRequestMethod(APIRequestMethod.POST);APIEndpoint endpoint = client.apiEndpoints().create(request);
Returns the created API endpoint object with all specified properties and system-generated fields.
Response
string
Unique identifier for the API endpoint (UUID format).
string
API endpoint name.
string
Fully qualified name in format service.collection.endpointName.
string
Human-readable display name.
string
Description of the API endpoint in Markdown format.
string
URL for the API endpoint.
string
HTTP request method (GET, POST, PUT, PATCH, DELETE).
object
Schema describing the request body.
Show properties
string
Type of schema, for example JSON.
array
Array of field definitions.
object
Schema describing the response body.
Show properties
string
Type of schema, for example JSON.
array
Array of field definitions.
object
Reference to the parent API service.
Show properties
string
UUID of the API service.
string
Type of entity (always apiService).
string
Name of the API service.
string
Type of API service, for example Rest.
array
List of owners assigned to the API endpoint.
Show properties
string
UUID of the owner entity.
string
Type of owner entity, for example user, team.
string
Name of the owner entity.
array
Domain assignments for governance.
array
Classification tags applied to the API endpoint.
Show properties
string
Fully qualified name of the tag.
string
Type of label, for example Manual, Derived, Propagated.
string
State of the tag, for example Suggested, Confirmed.
object
Custom property values defined by your organization’s metadata schema.
number
Version number for the entity (starts at 0.1).
Create or Update (PUT)
Use PUT /v1/apiEndpoints instead of POST to perform an upsert. If an API endpoint with the same fullyQualifiedName already exists, it will be updated; otherwise, a new API endpoint is created. The request body is the same as POST.
curl -X PUT "{base_url}/api/v1/apiEndpoints" \ -H "Authorization: Bearer {access_token}" \ -H "Content-Type: application/json" \ -d '{ ... same body as POST ... }'
PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead. However, for certain fields (such as description, tags, owners, and custom properties), PUT preserves an already-populated value instead of overwriting it with an empty or omitted one — the exact behavior depends on the field and the calling user or bot’s permissions, not a blanket rule. See Entity Update Behavior for the full preserve/merge rules. Use PATCH to intentionally replace an existing value.
Bulk Create or Update (PUT)
Use PUT /v1/apiEndpoints/bulk to create or update multiple API endpoints in a single request. The request body is an array of create request objects.
API endpoint with same name already exists in collection (POST only)
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Collate Documentation","colors":{"primary":"#1570EF","light":"#1570EF","dark":"#1570EF"},"logo":"https://mintcdn.com/collatedocs/yvgGxaeRR5RwtQo6/public/images/icons/collate-logo.svg?fit=max\u0026auto=format\u0026n=yvgGxaeRR5RwtQo6\u0026q=85\u0026s=59d7983952a91cd53138369f2e21a5ac","favicon":"https://mintcdn.com/collatedocs/yvgGxaeRR5RwtQo6/public/images/icons/collate-monogram.svg?fit=max\u0026auto=format\u0026n=yvgGxaeRR5RwtQo6\u0026q=85\u0026s=a8507d257fb5cbd5ac2366790c55d8f7","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://sandbox.open-metadata.org/api"}},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"icon":"Headphones","href":"mailto:support@getcollate.io","label":"Support"},{"icon":"Book","href":"https://www.getcollate.io/blog","label":"Blogs"},{"href":"https://cloud.getcollate.io/","label":"Free Trial"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/collateinc","x":"https://twitter.com/collatedata","youtube":"https://www.youtube.com/@CollateData"},"links":[{"items":[{"label":"Terms of Service","href":"https://www.getcollate.io/terms"},{"label":"Privacy Policy","href":"https://www.getcollate.io/privacypolicy"},{"label":"Trust Center","href":"https://trustcenter.getcollate.io/"},{"label":"Contact Us","href":"https://www.getcollate.io/contact-sales"}]}]},"seo":{"metatags":{"robots":"index,follow"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"ga4":{"measurementId":"GTM-554C968W"}},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"collatedocs","hasAudioNarration":false,"actualSubdomain":"collatedocs","customDomains":["docs.getcollate.io"],"gitSource":{"type":"github","owner":"open-metadata","repo":"docs-collate","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afef95a5246eb87f360499b","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Connectors","count":1744},{"language":"default","tag":"SDKs \u0026 APIs","count":626},{"language":"default","tag":"Database","count":414},{"language":"default","tag":"Data Governance","count":329},{"language":"default","tag":"Data Assets","count":316},{"language":"default","tag":"SDKs and APIs","count":313},{"language":"default","tag":"Collate APIs","count":285},{"language":"default","tag":"Data Quality \u0026 Observability","count":237},{"language":"default","tag":"Pipeline","count":164},{"language":"default","tag":"Guide for Data Users","count":160}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":true,"enableAskAiSearchBar":false,"deflection":{"enabled":true,"email":"support@getcollate.io","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"694587850a00f222af972838","deploymentId":"694583b20a00f222af96d417","questionText":"How to set up SSO?","status":"active","generatedBy":"manual","createdAt":"2025-12-19T17:12:37.423Z","updatedAt":"2025-12-19T17:12:37.423Z","__v":0},{"_id":"6945876e0a00f222af97266a","deploymentId":"694583b20a00f222af96d417","questionText":"How to use AskCollate?","status":"active","generatedBy":"manual","createdAt":"2025-12-19T17:12:14.884Z","updatedAt":"2025-12-19T17:12:14.884Z","__v":0},{"_id":"694587660a00f222af9725a6","deploymentId":"694583b20a00f222af96d417","questionText":"How to set up Snowflake?","status":"active","generatedBy":"manual","createdAt":"2025-12-19T17:12:06.575Z","updatedAt":"2025-12-19T17:12:06.575Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"public/globals.css","content":"/* latin-ext */\n@font-face {\n font-family: 'DM Sans';\n font-style: italic;\n font-weight: 100 1000;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Fp2ywxg089UriCZa4ET-DNl0.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'DM Sans';\n font-style: italic;\n font-weight: 100 1000;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Fp2ywxg089UriCZa4Hz-D.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* latin-ext */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 100 1000;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Hp2ywxg089UriCZ2IHSeH.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 100 1000;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Hp2ywxg089UriCZOIHQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n@tailwind base;@tailwind components;@tailwind utilities;:root{--top-nav-height: 70px;--main-nav-height: 42px;--side-nav-width: 288px;--side-nav-collapsed-width: 42px;--select-dropdown-default-height: 28px;--select-dropdown-default-width: 165px;--side-nav-width: min(20%, 300px);--api-side-nav-width: max(14%, 220px);--content-div-width: min(17%, 250px);--default-border-color: #dce3ec;--primary-color: #5469d4;--primary-shadow-color: #5469d433;--primary-background-color: rgba(84, 105, 212, 0.05);--select-background-color: #f4f7ff;--icon-background-color: #f1f3fe;--select-border-color: #e9eefc;--homepage-container-px: 130px;--default-text-color: rgb(60, 66, 87);--gray-text-color: rgba(60, 66, 87, 0.7);--white-color: #fff;--top-nav-color: #f7fafc;--code-background-color: #212d63;--code-gray-background-color: rgb(79, 86, 107);--code-light-background-color: #f7fafc;--code-toolbar-color: #212d63;--code-gray-toolbar-color: #3c4257;--code-light-toolbar-color: #ffffff;--code-light-border-color: #e3e8ee;--code-filename-color: #a4cdfe;--code-gray-filename-color: #dadce1;--code-light-filename-color: #f7fafc;--code-block-text-color: #f5fbff;--purple-bg-color: #7147e81a;--green-bg-color: #0084761a;--pink-bg-color: #b02aac1a;--purple-icon-color: #7147e8;--green-icon-color: #008376;--pink-icon-color: #b02aac;--beta-label-color: #0950C5;--beta-label-bg-color: #E4EEFF;--prod-label-color: #81C562;--prod-label-bg-color: #EEFBE7;--stable-label-color: #1890ff;--stable-label-bg-color: #e6f7ff;--connector-icon-bg-color: #F8F8F8;--green-tag-color: #43A047;--green-tag-bg-color: #43A0471A;--orange-tag-color: #FF7C50;--orange-tag-bg-color: #FF7C501A}body{font-family:\"DM Sans\", -apple-system, BlinkMacSystemFont, \"Segoe UI\", Roboto, Helvetica,\n Arial, sans-serif, \"Apple Color Emoji\", \"Segoe UI Emoji\", \"Segoe UI Symbol\";color:var(--default-text-color);margin:0;font-size:16px;font-weight:400;-webkit-font-smoothing:antialiased}h1,h2,h3,h4,h5,h6{font-weight:600;font-family:\"DM Sans\"}b,strong{font-weight:600}p{line-height:1.5em;margin:8px 0px 0px 0px;color:#414651}h1{font-size:36px;line-height:44px;color:#222244!important;margin-bottom:10px!important}h2{font-size:30px;line-height:38px}h3{font-size:24px;line-height:32px}h4{font-size:20px;line-height:30px}h5{font-size:18px;line-height:28px}h6{font-size:16px;line-height:24px}a{color:var(--primary-color);font-weight:500}li::marker{color:var(--primary-color)}ol{list-style:decimal;margin-top:16px;margin-left:16px}ol li::marker{color:var(--default-text-color)}li>ul{margin-top:0px;margin-left:16px}pre{border-radius:6px;background-color:var(--code-background-color)}pre,code{-ms-overflow-style:none;scrollbar-width:none}*::-webkit-scrollbar{display:none}*{scrollbar-width:none}pre::-webkit-scrollbar,code::-webkit-scrollbar{display:none}a.link{color:#004CD3;font-weight:600;text-decoration:none;border:none}a.link:hover{text-decoration:underline}.connector-tab{display:block;width:100%;text-align:start;padding:8px;cursor:pointer;border-radius:4px}.connector-tab:hover{background-color:var(--primary-background-color)}.active-connector{border:0.5px solid var(--select-border-color);background-color:var(--primary-background-color);color:var(--primary-color);font-weight:600}.divider{color:var(--default-border-color)}.icons{height:2rem;width:2rem}.cloud-button{border-radius:1rem;border:1px solid rgb(194, 128, 255);background-color:rgb(194, 128, 255)}.search-box{height:2.25rem;width:550px;border:1px solid #f4f4f4;border-radius:0.5rem;background-color:#f4f4f4;padding:4px 20px;color:#9e9d9d;display:flex;align-items:center}.search{width:90%;height:90%;border:none;background-color:#f4f4f4;outline:none}.overview-container{width:100vw;display:flex;flex-direction:column;justify-content:center;padding:50px 10%;background:#f4f7ff}.overview-heading{font-weight:700;font-size:22px;line-height:42px;margin-bottom:12px}.container-heading{font-weight:700;font-size:22px;line-height:42px;margin-bottom:40px}.cards-container{display:grid;grid-template-columns:1fr 1fr 1fr;gap:32px}.blogs-container{display:grid;grid-template-columns:1fr 1fr 1fr;gap:32px}.homepage-containers{padding:0px 10%;margin:80px 0px 0px 0px}#myUL{list-style-type:none;margin:0;padding:0}.nested{display:none}.active{display:block;color:var(--primary-color)}.DownArrow{display:none}.RightArrow{display:block}.highlightedCode{background-color:#1a2652}.page-404{height:calc(100vh - var(--top-nav-height) - var(--main-nav-height))}.content{flex-grow:0;flex-shrink:1}.non-collapsed-content{width:calc(100vw - var(--side-nav-width))}.collapsed-content{width:calc(100vw - var(--side-nav-collapsed-width))}.card-icon-container{padding:8px;width:fit-content;border-radius:10px}.card-purple-icon{background-color:var(--purple-bg-color);border:1px solid #7147e8}.card-green-icon{background-color:var(--green-bg-color);border:1px solid #008376}.card-pink-icon{background-color:var(--pink-bg-color);border:1px solid #b02aac}.nav-bar-container{position:sticky;top:0px;z-index:100}.min-width-600{min-width:600px}@media (max-width: 1240px){.blogs-container{grid-template-columns:1fr 1fr}}@media (max-width: 900px){.cards-container{grid-template-columns:1fr 1fr}.blogs-container{grid-template-columns:1fr}.overview-container{padding:20px 60px;width:100%}.homepage-containers{padding:20px 60px;margin:32px 0px 0px 0px}}@media (max-width: 600px){.cards-container{grid-template-columns:1fr}.non-collapsed-content{display:none}.collapsed-content{width:calc(100% - 41px)}}#header h1,#header p{display:none!important}.mdx-content{margin-top:0px!important}.api-page-container{display:grid;grid-template-columns:var(--api-side-nav-width) calc(100vw - var(--api-side-nav-width))}.hash-link{overflow:hidden;width:0px;height:0px;display:block;visibility:hidden;text-decoration:none;pointer-events:none;margin-top:-300px!important;padding-top:300px}.cookie-modal{position:fixed;bottom:0;background-color:#F8FBFC;z-index:20;padding:1rem;box-shadow:var(--shadow-card);transform:translateY(100%);transition:transform 1.2s ease-in-out, visibility 1.2s ease-in-out;visibility:hidden;border:1px solid rgb(201, 196, 196);border-radius:10px}.cookie-modal p{color:#292929;font-weight:300}.cookie-modal-buttons{margin-top:2rem;display:flex;gap:0.75rem;justify-content:flex-end}.button{border-radius:1.5rem;padding:0.5rem 2rem;font-size:0.875rem;cursor:pointer;border:none}.button-accept{background-color:#7147E8;color:white}.button-reject{background-color:white;color:#7147E8;border:1px solid #7147E8}@media (min-width: 640px){.cookie-modal{margin:1.25rem;max-width:36rem}}@media (min-width: 1024px){.cookie-modal{max-width:48rem}}.cookie-modal.visible{transform:translateY(0);visibility:visible}.brand-docs-banner{font-weight:500;padding:0px 8px;border-radius:12px;margin-top:16px;width:fit-content}.breadcrumb-item:first-child{display:none}.breadcrumb-item:last-of-type a{color:#414651;pointer-events:none;cursor:text;text-decoration:none}#page-loader{position:fixed;top:0;left:0;width:0%;height:3px;background:linear-gradient(90deg, #3b82f6, #8b5cf6);z-index:9999;transition:width 0.3s ease}[data-component-part=\"version-select-trigger\"]{background:#EFF8FF!important;border:1.5px solid #B2DDFF!important;border-radius:100px!important;overflow:visible!important;padding:4px 14px!important;height:32px!important;font-weight:600!important;font-size:13px!important}[data-component-part=\"version-select-trigger\"]:hover{background:#E0F2FE!important;border-color:#7DD3FC!important}[data-component-part=\"version-select-trigger\"][data-state=\"open\"],[data-component-part=\"version-select-trigger\"][aria-expanded=\"true\"]{background:#DBEAFE!important;border-color:#93C5FD!important}[data-component-part=\"version-select-trigger\"] span{color:#026AA2!important;font-weight:600!important;max-width:none!important}[data-component-part=\"version-select-item\"]{border-radius:8px!important;font-size:13px!important;font-weight:500!important;padding:6px 12px!important;cursor:pointer!important}[data-component-part=\"version-select-item\"][data-state=\"checked\"],[data-component-part=\"version-select-item\"][aria-checked=\"true\"]{color:#1570EF!important;background:#EFF8FF!important;font-weight:600!important}#navbar .border-b{border:none}#navbar .nav-tabs{background-color:#FAFAFA;width:max-content;border:1px solid #EAECF5;border-radius:100px;margin:24px auto 4px;column-gap:16px;max-width:100%;overflow-x:auto;display:flex;flex-wrap:nowrap;justify-content:flex-start}#navbar .nav-tabs .nav-tabs-item{padding:12px 24px;font-size:16px;white-space:nowrap;flex-shrink:0;color:#414651;font-weight:500}@media (max-width: 1440px){#navbar .nav-tabs{column-gap:4px}#navbar .nav-tabs .nav-tabs-item{padding:10px 16px;font-size:15px}}#navbar .nav-tabs a[href^=\"/how-to-guides/\"]{display:none!important}#navbar .nav-tabs a[href^=\"/ai-2-0/how-to-guides/\"]{display:none!important}#navbar .nav-tabs .nav-tabs-item:hover{color:#181D27;text-decoration:none}#navbar .nav-tabs .nav-tabs-item .absolute{display:none!important}#navbar .nav-tabs .nav-tabs-item[data-active=\"true\"]{color:#1570EF;background-color:#EFF8FF;border:1.5px solid #B2DDFF;border-radius:100px;font-weight:600}#navbar .nav-tabs:has(a[href^=\"/how-to-guides/\"][data-active=\"true\"]) a.nav-tabs-item[href=\"/how-to-guides\"]{color:#1570EF;background-color:#EFF8FF;border:1.5px solid #B2DDFF;border-radius:100px;font-weight:600}body:has(.homepage-container) #navbar .nav-tabs .nav-tabs-item[data-active=\"true\"]:not([href=\"/\"]):not([href=\"/ai-2-0\"]){color:#414651;background-color:transparent;border:1.5px solid transparent;border-radius:0;font-weight:500;text-shadow:none}body:has(.homepage-container) #navbar .nav-tabs .nav-tabs-item[href=\"/\"],body:has(.homepage-container) #navbar .nav-tabs .nav-tabs-item[href=\"/ai-2-0\"]{color:#1570EF;background-color:#EFF8FF;border:1.5px solid #B2DDFF;border-radius:100px;font-weight:600;text-shadow:-0.2px 0 0 currentColor, 0.2px 0 0 currentColor}#navbar .h-10{height:auto!important}.navbar-link a{background-color:transparent;color:#535862;font-weight:600}.nav-logo{height:36px}.navbar-link a:hover{color:#181D27;background-color:transparent}.products-container h2{color:#222244;font-size:22px;font-weight:600}.card{border:none;box-shadow:0px 4px 12px -1px rgba(10, 13, 18, 0.08);transition:all 0.3s ease}.card>*{padding:20px;transition:all 0.3s ease}.card h2{color:#181D27;font-size:18px;line-height:20px}.card:hover{box-shadow:0px 3px 3px -1.5px #0A0D120A,\n 0px 8px 8px -4px #0A0D1208,\n 0px 20px 24px -4px #0A0D1214;transform:translateY(-2px)}.card:hover>*{padding:24px;margin:-4px}.connector-page .card [data-component-part=\"card-content-container\"]{position:relative}.card [data-component-part=\"card-icon\"]:has(>svg){background-color:#e6f1ff;padding:24px;border-radius:100%;display:inline-flex;align-items:center;justify-content:center}body:not(:has(.homepage-container)) .card [data-component-part=\"card-icon\"]{width:auto!important;height:auto!important;min-width:32px!important;min-height:32px!important;align-self:flex-start!important}body:not(:has(.homepage-container)) .card [data-component-part=\"card-icon\"] img{width:32px!important;height:32px!important;object-fit:contain;flex-shrink:0}.connector-page div[data-component-part=\"card-icon\"]{background-color:#F8F9FC;padding:16px;border-radius:100%;display:inline-flex;align-items:center;justify-content:center;width:auto!important;height:auto!important}.connector-page div[data-component-part=\"card-icon\"] svg,.connector-page div[data-component-part=\"card-icon\"] img{width:32px!important;height:32px!important;object-fit:contain;flex-shrink:0;position:relative;z-index:1}.prod-beta-chip{display:flex;gap:4px;font-size:10px;width:max-content;border-radius:100px;padding:0px 6px;font-weight:500;position:absolute;top:12px;right:12px}.prod-beta-chip.prod{color:#067647;background-color:#ECFDF3;border:1px solid #ABEFC6}.prod-beta-chip.beta{color:#175CD3;background-color:#EFF8FF;border:1px solid #B2DDFF}.prod-beta-chip img{margin:0px}.prod-beta-chip span{margin-top:-7px}#sidebar-content{border:none;top:132px!important;height:calc(100vh - 132px)!important}.sidebar-group-header{display:none}.my-2:has(ul.sidebar-group a[href^=\"/api-reference\"])>.sidebar-group-header,.my-2:has(ul.sidebar-group a[href*=\"/developer-guide/\"])>.sidebar-group-header{display:flex}.sidebar-group-header h5{color:#222244;font-size:14px;font-weight:600}#table-of-contents-content .toc-item a{color:#414651}#table-of-contents-content .toc-item a:hover{color:#414651;border-color:#D5D9EB}#table-of-contents-content .toc-item a.text-primary{color:#004CD3;border-color:#004CD3;font-weight:600}body:not(:has(.homepage-container)) .mdx-content h1,.products-container h1,.collate-ai-container h1{display:flex;flex-direction:column;align-items:flex-start;margin-top:0!important}body:not(:has(.homepage-container)) .mdx-content h1::before,.products-container h1::before,.collate-ai-container h1::before{content:\"Collate Documentation\";display:block;background-color:#F0F9FF;color:#0BA5EC;padding:4px 12px;border-radius:100px;font-size:14px;font-weight:600;line-height:1.5;margin-bottom:16px;width:fit-content;flex-shrink:0}h1.ConnectorName::before{position:absolute;top:-2px;left:0px}body:has(.homepage-container) #search-bar-entry,body:has(.homepage-container) #assistant-entry{display:none!important}.search-container{position:relative;margin-top:64px;display:flex;align-items:center;justify-content:center;width:100%;max-width:800px;margin-left:auto;margin-right:auto;padding:0px 6px}.homepage-search-input{width:100%;padding:18px 58px 18px 70px;border:2px solid #EAECF5;border-radius:100px;font-size:16px;color:#3C4257;cursor:pointer;transition:all 0.2s ease;box-sizing:border-box}.homepage-search-input::placeholder{color:#CECFD2;font-size:18px}.homepage-search-input:hover{background-color:#FFFFFF}.homepage-search-input:focus{outline:none;background-color:#FFFFFF;box-shadow:0 0 0 3px rgba(84, 105, 212, 0.1)}.ask-ai-icon-button{position:absolute;left:26px;top:12px;background:none;border:none;padding:0;cursor:pointer;display:flex;align-items:center;justify-content:center;z-index:20;pointer-events:auto}.ask-ai-icon{color:#9CA3AF;pointer-events:auto;width:40px!important;height:40px!important}.search-shortcut{position:absolute;right:20px;top:50%;transform:translateY(-50%);color:#9CA3AF;padding:4px 8px;border-radius:4px;font-size:12px;font-weight:600;pointer-events:none;white-space:nowrap}.navbar-link:last-of-type a{background-color:#1570EF;color:white;border-radius:100px;display:flex;justify-content:center}.navbar-link:last-of-type a:hover{background-color:#0257cd}body:has(.how-to-guides-container) #sidebar-content,body:has(.sdk-container) #sidebar-content,body:has(.connector-page) #sidebar-content,body:has(.getting-started-container) #sidebar-content,body:has(.collate-ai-container) #sidebar-content{display:none}body:has(.how-to-guides-container) #content-container,body:has(.sdk-container) #content-container,body:has(.connector-page) #content-container,body:has(.getting-started-container) #content-container,body:has(.collate-ai-container) #content-container{max-width:1300px!important}.collate-ai-container{margin-top:10px}article iframe,.prose iframe{max-width:600px!important;width:100%!important;margin:0 auto!important;display:block!important;height:auto!important;aspect-ratio:16 / 9!important;border:none!important}@media (max-width: 1024px){.navbar-link:first-of-type{margin-top:20px}article iframe,.prose iframe{max-width:100%!important;width:100%!important;height:auto!important;aspect-ratio:16 / 9!important}}@media (max-width: 768px){article iframe,.prose iframe{max-width:100%!important;width:100%!important;margin:0!important;height:auto!important;aspect-ratio:16 / 9!important}}.card:not(:has([data-component-part=\"card-icon\"])){border:1px solid #EAECF5!important;background-color:#F8F9FC!important;box-shadow:none!important}.card.card:not(:has([data-component-part=\"card-icon\"])) h2{color:#004CD3;font-weight:500;font-size:20px;margin-bottom:12px;line-height:30px}.card.card:not(:has([data-component-part=\"card-icon\"])):hover h2{text-decoration:underline}.how-to-guides-container ul{list-style:none;padding-left:0}.how-to-guides-container ul li{padding-left:28px;position:relative;margin-bottom:8px}.how-to-guides-container ul li::before,.sdk-container ul li::before,.python-container ul li::before{content:'';position:absolute;left:0;top:6px;width:16px;height:16px;background-color:transparent;background-image:url(\"/public/images/icons/check-circle.svg\");background-size:contain;background-repeat:no-repeat}.sdk-container .card img{min-width:40px!important;width:40px!important;height:40px!important}.code-block,.code-block [data-component-part=\"code-block-root\"]{border:none!important;background-color:#3E444F!important;border-radius:16px!important;backdrop-filter:blur(40px)}.code-block pre,.code-block code,.code-block span{color:#E5E7EB!important;background-color:transparent!important}.code-block pre{background-color:transparent!important}.python-container{background-color:#FAFAFA;border-radius:12px;padding:6px 20px}.callout [data-component-part=\"callout-content\"]{color:#414651!important}@layer utilities{.callout [data-component-part=\"callout-content\"] a{color:var(--primary-color)!important}}.chat-assistant-floating-input{max-width:370px!important;margin-left:auto!important;margin-right:auto!important}div:has(>#chat-assistant-sheet){border:none}div:has(>#chat-assistant-sheet) .cursor-col-resize{display:none!important}#chat-assistant-sheet{margin-top:0.4rem!important;min-height:90%!important;border:1px solid #EAECF5;border-top-left-radius:24px;border-top-right-radius:24px;box-shadow:0px 2px 2px -1px #0A0D120A,\n 0px 4px 6px -2px #0A0D1208,\n 0px 12px 16px -4px #0A0D1214;background:#0A0D12;color:rgba(255, 255, 255, 0.9)}.chat-assistant-sheet-header span{color:rgba(255, 255, 255, 0.9)!important}.chat-assistant-sheet-header span.font-medium{font-size:0}.chat-assistant-sheet-header span.font-medium::before{content:\"Ask AI\";font-size:0.875rem;font-weight:600}.chat-assistant-sheet-header svg{width:16px;height:16px;color:rgba(255, 255, 255, 0.8)}#chat-assistant-textarea{background-color:#373A41;border-radius:100px;color:rgba(255, 255, 255, 0.9);padding:14px 48px 14px 16px;max-height:52px!important;overflow-y:auto}#chat-assistant-textarea::placeholder{color:rgba(255, 255, 255, 0.6)}.chat-assistant-send-button{width:32px!important;height:32px!important;top:50%!important;bottom:auto!important;transform:translateY(-50%);background-color:#2970FF}#chat-assistant-textarea~span{top:50%!important;bottom:auto!important;transform:translateY(-50%)}.chat-assistant-send-button:hover{background-color:#004EEB}.chat-assistant-send-button svg{width:16px;height:16px}div:has(>div>#chat-assistant-textarea){border:none!important;background-color:#373A41}#chat-content{margin-top:12px}#chat-content .rounded-2xl.bg-gray-100{background:#22262F!important}#chat-content button{color:rgba(255, 255, 255, 0.6)}#chat-content button[aria-label*=\"Vote\"]:hover,#chat-content button[aria-label=\"Copy chat response\"]:hover{color:#22262F}#chat-content .whitespace-pre-line,#chat-content li{color:rgba(255, 255, 255, 0.7)}#chat-content .rounded-2xl.bg-gray-100 .text-gray-800,#chat-content .rounded-2xl.bg-gray-100 div{color:#FFFFFFE5!important}#assistant-entry{margin-left:auto;border:2px solid #1570EF;background-color:transparent}#assistant-entry svg,#assistant-entry span{background:none;-webkit-text-fill-color:#1570EF;font-weight:600;color:#1570EF}#assistant-entry:hover{background:linear-gradient(45deg, #175CD3 0%, #1570EF 100%)}#assistant-entry:hover svg,#assistant-entry:hover span{background:none;-webkit-background-clip:unset;-webkit-text-fill-color:white;background-clip:unset;color:white}div:has(>#search-bar-entry):has(>#assistant-entry){flex-direction:row-reverse!important}div[data-component-part=\"code-group-tab-bar\"] p{margin-top:0px}table{width:100%;border-collapse:collapse;margin:16px 0;border:1px solid #EAECF5;border-radius:12px}table thead{background-color:#F8F9FC}table th{padding:12px 24px!important;text-align:left;font-weight:600;color:#181D27;border-bottom:2px solid #EAECF5}table td{padding:12px 24px!important;color:#414651;border-bottom:1px solid #EAECF5}table tr:last-child td{border-bottom:none}table tr:hover{background-color:#F8F9FC}.space-x-2>:not([hidden])~:not([hidden]){margin:0px}.header-logo{max-width:max-content;border-radius:32px 80px 0 0;background:#224;padding:9px 44px 10px 45px;display:flex;gap:20px;align-items:center}.header-logo .collate-logo{width:84px;height:14px}.header-logo .x-icon{width:18px;height:18px}.header-logo .om-logo{width:64px;height:25px}.collate-summit{margin:0px auto 72px;max-width:1200px;padding:20px}.summit-content{background-image:url('/public/images/banner-bg.png');background-size:100% 100%;background-position:center;background-repeat:no-repeat;border-radius:0px 20px 20px 20px;padding:28px 44px;width:100%;box-sizing:border-box;display:flex;align-items:center;justify-content:space-between;gap:24px;position:relative;z-index:24}.summit-content .summit-header{font-size:48px;font-weight:400;color:#224;line-height:52px}.summit-content p{color:#5816DC;margin-top:0px;margin-left:4px;font-size:28px;font-weight:600}.summit-content .explore-collate{background-color:#FBE200;color:black;font-size:18px;white-space:nowrap;padding:11px 20px;border-radius:6px;font-weight:600}.summit-content .explore-collate:hover{background-color:#dec908}.summit-content .explore-collate a{color:black;font-weight:600}@media (max-width: 768px){.summit-content{flex-direction:column;align-items:center;text-align:center;padding:48px 24px}}@media (max-width: 640px){.header-logo{padding:9px 36px 10px 24px}}"},{"filePath":"public/modal.css","content":".modal{position:fixed;left:0;top:0;right:0;bottom:0;background-color:#00000080;display:flex;align-items:center;justify-content:center;opacity:0;transition:all 0.3s ease-in-out;pointer-events:none;z-index:999}.modal.enter-done{opacity:1;pointer-events:visible}.modal.exit{opacity:0}.modal-content{margin:0 10px;width:600px;height:300px;background-color:var(--white-color);transition:all 0.3s ease-in-out;transform:translateY(-200px)}.modal.enter-done .modal-content{transform:translateY(0)}.modal.exit .modal-content{transform:translateY(-200px)}"},{"filePath":"snippets/components/CodePreview.css","content":".split-layout{display:grid;grid-template-columns:1fr 1fr;gap:2rem;margin:2rem 0;align-items:start}@media (max-width: 768px){.split-layout{grid-template-columns:1fr;gap:1rem}}.code-content .code-block [data-component-part=\"code-block-root\"]{background-color:#0b1e3d!important}.content-panel{display:flex;flex-direction:column;gap:1.5rem;padding-right:1rem}.content-section{padding:0.5rem 1rem;border-left:2px solid transparent;border-radius:6px;cursor:pointer;position:relative;box-sizing:border-box;transition:background 0.25s ease,\n border-color 0.25s ease,\n box-shadow 0.25s ease}.content-section:hover{background:linear-gradient(\n 90deg,\n rgba(176, 176, 176, 0.08) 0%,\n rgba(176, 176, 176, 0.03) 100%\n );border-left-color:rgba(176, 176, 176, 0.5)}.content-section.active{background:linear-gradient(\n 90deg,\n rgba(176, 176, 176, 0.15) 0%,\n rgba(176, 176, 176, 0.05) 100%\n );border-left-color:#b0b0b0;box-shadow:0 2px 8px rgba(176, 176, 176, 0.1),\n inset 0 0 20px rgba(176, 176, 176, 0.05);color:rgb(63, 65, 69)}.content-section.active::before{content:'';position:absolute;left:0;top:0;bottom:0;width:2px;background:linear-gradient(\n 180deg,\n #c0c0c0 0%,\n #b0b0b0 50%,\n #a0a0a0 100%\n )}.content-section h4{margin:0 0 0.75rem 0;font-size:1rem;font-weight:600;color:#1a1a1a}.content-section p{margin:0.5rem 0;line-height:1.6;color:#4a4a4a}.content-section code{background:rgba(0, 0, 0, 0.05);padding:0.2em 0.4em;border-radius:3px;font-size:0.9em}.code-panel{position:sticky;top:calc(var(--navbar-height, 64px) + 6rem);height:calc(\n 100vh - var(--navbar-height, 64px) - 6rem\n );display:flex;flex-direction:column;border:1px solid #e5e7eb;border-radius:8px;overflow:hidden;background:#1e1e1e;box-shadow:0 4px 6px rgba(0, 0, 0, 0.1)}.code-panel [data-component-part=\"code-block-root\"]{padding:0rem 1rem}.code-panel .code-block{margin:0}.code-header{display:flex;justify-content:space-between;align-items:center;padding:0.4rem 1rem;background:#0b1e3d;border-bottom:1px solid #404040;color:white;font-size:0.875rem;font-family:'Monaco', 'Menlo', 'Ubuntu Mono', monospace}.copy-btn{display:flex;align-items:center;gap:0.5rem;padding:0.375rem 0.75rem;background:transparent;border:1px solid #404040;border-radius:4px;color:#a0a0a0;cursor:pointer;transition:all 0.2s ease;font-size:0.875rem}.copy-btn:hover{background:#404040;border-color:#606060;color:#fff}.copy-btn svg{width:16px;height:16px}.copy-btn .icon-check{display:none}.copy-btn[data-copied=\"true\"] .icon-copy{display:none}.copy-btn[data-copied=\"true\"] .icon-check{display:block;color:#10b981}.code-content{position:relative;flex:1 1 auto;min-height:0;overflow-y:auto;overflow-x:auto;background:#0b1e3d;scroll-behavior:smooth;padding:14px 0px}.code-content::-webkit-scrollbar{width:8px;height:8px}.code-content::-webkit-scrollbar-track{background:#2d2d2d}.code-content::-webkit-scrollbar-thumb{background:#404040;border-radius:4px}.code-content::-webkit-scrollbar-thumb:hover{background:#606060}.code-content pre{margin:0;padding:0rem 1rem;background:transparent;color:#d4d4d4;font-family:'Monaco', 'Menlo', 'Ubuntu Mono', monospace;font-size:0.875rem;line-height:1.6;white-space:pre;word-wrap:normal;overflow-wrap:normal;position:relative}.code-content pre code{background:transparent;padding:0;color:inherit;font-size:inherit;border-radius:0;display:block;white-space:pre}.code-line{display:block;padding-left:1rem;padding-right:1rem;margin-left:-1rem;margin-right:-1rem;transition:all 0.2s ease;position:relative;white-space:pre;line-height:inherit;border-left:2px solid transparent}.code-line::after{content:'\\a';white-space:pre}.code-line.highlighted{background:rgba(200, 200, 200, 0.15)!important;border-left:2px solid #d0d0d0;padding-left:calc(1rem - 2px);min-height:1.5em}.code-line.highlighted::before{content:'';position:absolute;left:0;top:0;bottom:0;width:2px;background:#d0d0d0;z-index:1}.code-line.highlighted+.code-line.highlighted{border-top:none}.code-line.highlighted:not(.code-line.highlighted+.code-line.highlighted){border-top-left-radius:4px}.code-line.highlighted:not(:has(+.code-line.highlighted)){border-bottom-left-radius:4px}.line-number{display:inline-block;min-width:2.5em;padding-right:1em;margin-right:0.5em;text-align:right;color:#858585;user-select:none;border-right:1px solid #404040}@media (prefers-color-scheme: dark){.content-section p{color:#c0c0c0}.content-section code{background:rgba(255, 255, 255, 0.1)}.code-panel{border-color:#404040}}@media (max-width: 768px){.code-panel{position:relative;top:0;max-height:400px}.split-layout{grid-template-columns:1fr}}.code-content [data-testid=\"copy-code-button\"]{display:none!important}.code-content #ask-ai-code-block-button{display:none!important}div[data-fade-overlay=\"true\"]{--fade-color-light: transparent !important;--fade-color-dark: transparent !important;display:none!important}:has([data-floating-buttons])>[data-component-part=code-block-root] pre>code{padding-right:0px!important}@media (max-width: 768px){.code-panel{position:relative;top:0;height:400px}}"},{"filePath":"snippets/components/ConnectorDetailsHeader/ConnectorDetailsHeader.css","content":".container{margin:48px 0px!important;display:flex;flex-direction:column;gap:6px}.Heading{display:flex;justify-content:space-between;padding-bottom:8px;border-bottom:1px solid var(--default-border-color)}.ConnectorName{font-size:32px;font-weight:700;margin-bottom:0px}.PlatformDetails{display:flex;align-items:center;gap:4px;font-size:14px;color:var(--gray-text-color)}.PlatformIcon{padding:4px;background-color:var(--connector-icon-bg-color);border:1px solid var(--default-border-color);border-radius:12px}.ImageContainer{background-color:var(--connector-icon-bg-color);padding:12px;border:1px solid var(--default-border-color);border-radius:28px}.IconContainer{background-color:#F8F9FC;padding:16px;border-radius:50%;display:inline-flex;align-items:center;justify-content:center;width:64px;height:64px;flex-shrink:0}.ConnectorIcon{width:32px!important;height:32px!important;object-fit:contain;display:block;margin:0}.FeaturesHeading{font-size:14px;color:var(--gray-text-color)}.SubHeading{display:flex;flex-direction:column;gap:8px}.FeaturesList{display:flex;flex-wrap:wrap;gap:12px}.FeatureTag{padding:4px 10px;font-size:12px;border-radius:14px;width:fit-content;display:flex;align-items:center;gap:4px}.AvailableFeature{color:var(--green-tag-color);border:1px solid var(--green-tag-color);background-color:var(--green-tag-bg-color)}.UnavailableFeature{color:var(--orange-tag-color);border:1px solid var(--orange-tag-color);background-color:var(--orange-tag-bg-color)}.StageBadge{font-size:10px;height:auto;color:var(--green-tag-color)}"},{"filePath":"snippets/components/ConnectorGrid/Integrations.css","content":".no-scrollbar::-webkit-scrollbar{display:none}.no-scrollbar{-ms-overflow-style:none;scrollbar-width:none}.integrations-section{padding:3rem 1rem 9rem;max-width:1300px;margin:0 auto}.integrations-card{background:#FAFAFA;border-radius:12px;border:1px solid #EAECF5;display:flex;height:660px;overflow:hidden;position:relative;padding:40px 40px 40px 0px}.integrations-mobile-header{display:none;width:100%;background:#ffffff;border-bottom:1px solid #d9daee;padding:32px;font-size:20px;justify-content:center;align-items:center;gap:12px;position:sticky;top:0;z-index:15;cursor:pointer}.arrow{transition:transform 0.3s ease}.arrow.open{transform:rotate(180deg)}.arrow-down{width:10px;height:10px}.integrations-sidebar{width:220px;border-right:1px solid #EAECF5;display:flex;flex-direction:column;position:sticky;top:0;z-index:5}.sidebar-item{display:block;width:100%;padding:12px 22px;font-size:16px;color:#535862;cursor:pointer;white-space:nowrap;flex-shrink:0;text-align:right;font-weight:500;border-right:2px solid transparent}.sidebar-item:hover{color:#414651;border-right:2px solid #D5D9EB}.sidebar-item.active{border-right:2px solid #004CD3;font-weight:600;color:#004CD3}.integrations-grid{flex:1;padding:20px 32px;overflow-y:auto;display:grid;gap:20px;align-content:flex-start}.integrations-grid.desktop{grid-template-columns:repeat(auto-fill, minmax(200px, 1fr))}.integrations-grid.mobile{display:none}.integration-card{max-height:110px;text-decoration:none;display:flex;align-items:center;gap:12px;background-color:white;box-shadow:0px 4px 12px -1px #0A0D1214;border-radius:12px;padding:12px 20px;box-sizing:border-box;transition:all 0.3s ease}.integration-card span{color:#181D27;font-weight:500;font-size:16px;line-height:120%}a.integration-card span:hover{text-decoration:none}a.integration-card:hover{box-shadow:0px 3px 3px -1.5px #0A0D120A,\n 0px 8px 8px -4px #0A0D1208,\n 0px 20px 24px -4px #0A0D1214;padding:16px 24px;margin:-4px;text-decoration:none;transform:translateY(-2px)}.integration-card img{width:32px;height:32px;object-fit:contain;flex-shrink:0}.load-more{grid-column:span 2;padding:24px;font-size:20px;background:#ffffff;border:none;cursor:pointer}@media (max-width: 1024px){.integrations-card{flex-direction:column;height:auto;padding:0px;overflow:auto}.integrations-mobile-header{display:flex}.integrations-sidebar{display:none;width:100%;position:absolute;top:98px;left:0;right:0;border-right:none;border-bottom:1px solid #d9daee;background:#ffffff;overflow-y:scroll}.integrations-sidebar.open{display:block}.sidebar-item{text-align:center}.sidebar-item.active{border-right:none}.integrations-grid.desktop{display:none}.integrations-grid.mobile{display:grid;grid-template-columns:repeat(2, 1fr);padding:24px}}"},{"filePath":"style.css","content":".homepage-container,.sdk-api-container{max-width:1440px;margin:0 auto;padding:0px 10px 40px}.collate-ai-iframe{margin:32px 0px 40px}.banner-content{padding:96px 0;background:radial-gradient(46.63% 44.4% at 50% 50%, rgba(201, 207, 255, 0.2) 0%, rgba(255, 255, 255, 0.2) 100%)}.page-header{color:#181D27!important;font-weight:600;font-size:56px;text-align:center;margin-top:24px}#header-highlight{background:linear-gradient(to top, #016AFB 0%, #00E0EE 100%);-webkit-background-clip:text;-webkit-text-fill-color:transparent;background-clip:text}.page-description{text-align:center;color:#717680;font-size:20px;margin-top:20px}.header-description{font-size:18px;margin-top:16px}.chips{display:flex;justify-content:center;gap:24px;margin-top:24px}.chip{padding:8px 12px;border-radius:100px;box-shadow:0px 4px 12px -1px rgba(10, 13, 18, 0.08);display:flex;gap:12px;align-items:center;font-weight:500;width:max-content}.chip.blue{background:linear-gradient(93.13deg, #EBF9FF 0%, #ECF4FF 189.43%);color:#194185}.chip.blue:hover{background:linear-gradient(93.13deg, #E5F7FF 0%, #DDECFF 189.43%);color:#175CD3}.chip.purple{background-color:#F0F9FF;color:#0BA5EC;margin:0 auto;padding:8px 20px;box-shadow:none;font-size:14px}.release-banner{max-width:1300px;margin:0 auto;background:linear-gradient(135deg, rgba(195, 201, 252, 0.5) 0%, rgba(142, 234, 252, 0.5) 100%);padding:48px 100px;border-radius:24px}.banner-image{width:1200px;border:3px solid #BED2FB;border-radius:16px;box-shadow:0px 2px 2px -1px #0A0D120A,\n 0px 4px 6px -2px #0A0D1208,\n 0px 12px 16px -4px #0A0D1214}.release-banner-content{display:grid;grid-template-columns:repeat(2, 1fr);gap:50px;align-items:center}.release-banner-content h2{color:#181D27;font-weight:500;font-size:32px;margin-bottom:16px}.release-banner-content p{color:#414651;font-size:18px;margin-bottom:40px}.release-banner-content a{background-color:white;box-shadow:0px 2px 2px -1px #0A0D120A,\n 0px 4px 6px -2px #0A0D1208,\n 0px 12px 16px -4px #0A0D1214;padding:12px 24px;border-radius:99px;font-size:18px;font-weight:500;color:#131313}.release-banner-content a:hover{text-decoration:underline}.guides,.highlights,.quick-links{padding:48px 48px 96px}.guide-header{font-weight:500;font-size:40px;color:#181D27;text-align:center;margin-top:24px}.guide-list{display:grid;grid-template-columns:repeat(7, 1fr);gap:24px;margin:0 auto;margin-top:52px;max-width:100%}.guide-card{box-shadow:0px 4px 12px -1px rgba(10, 13, 18, 0.08);padding:20px;border-radius:20px;display:flex;flex-direction:column;align-items:center;color:#252B37;font-weight:500;font-size:18px;gap:16px;width:100%;transition:all 0.3s ease;text-align:center}.guide-card:hover{box-shadow:0px 20px 24px -4px #0A0D1214;transform:translateY(-4px);padding:24px;margin:-4px}a.guide-card img{width:80px!important;height:80px!important}.see-all{text-align:center;margin:64px auto 0px;color:#004CD3;font-size:18px;font-weight:500;box-shadow:0px 2px 2px -1px rgba(10, 13, 18, 0.04),\n 0px 4px 6px -2px rgba(10, 13, 18, 0.03),\n 0px 12px 16px -4px rgba(10, 13, 18, 0.08);width:max-content;padding:12px 24px;background-color:#EAF4FF;border-radius:100px}.see-all:hover{background-color:#CDE4FE;color:#1849A9}.highlight-cards{max-width:850px;display:grid;grid-template-columns:repeat(2, 1fr);gap:32px;margin:60px auto 0px}.highlight-card{box-shadow:0px 4px 12px -1px rgba(10, 13, 18, 0.08);padding:20px;border-radius:12px;transition:all 0.3s ease}.highlight-card p{font-size:18px;color:#717680}.highlight-card:hover{box-shadow:0px 3px 3px -1.5px rgba(10, 13, 18, 0.04),\n 0px 8px 8px -4px rgba(10, 13, 18, 0.03),\n 0px 20px 24px -4px rgba(10, 13, 18, 0.08);padding:24px;margin:-4px;transform:translateY(-2px)}.highlight-card .icon{width:48px!important;height:48px!important}.highlight-header{font-size:20px;font-weight:500;color:#181D27;margin-top:12px}.read-more{margin-top:20px;display:flex;gap:10px;align-items:center;color:#175CD3;font-weight:600}.highlight-card:hover .read-more{color:#1849A9}.read-more img{margin-top:2px}.links{margin:0 auto;margin-top:40px;max-width:80%;display:grid;grid-template-columns:repeat(3, 1fr);justify-items:center}.link-header{color:#181D27;display:flex;gap:10px;align-items:center;margin-bottom:16px}.link-header h3{font-size:20px;font-weight:500}.link-list{color:#175CD3;font-weight:500;display:flex;flex-direction:column;gap:12px}.link-list a:hover{text-decoration:underline;color:#1849A9}.collate-video{background:linear-gradient(135deg, rgba(195, 201, 252, 0.5) 0%, rgba(142, 234, 252, 0.5) 100%);border-radius:24px;max-width:90%;margin:32px auto 64px;padding:36px 80px}.video-content{display:grid;grid-template-columns:repeat(2, 1fr);align-items:center;gap:16px}.video-container{width:100%;max-width:600px;margin:20px auto;padding:0 16px;box-sizing:border-box}.video-container iframe{width:100%;height:auto;aspect-ratio:16 / 9;display:block;border-radius:20px;border:3px solid #BED2FB}.video{border-radius:20px;border:3px solid #BED2FB;max-width:100%;height:auto;box-shadow:0px 2px 2px -1px rgba(10, 13, 18, 0.04),\n 0px 4px 6px -2px rgba(10, 13, 18, 0.03),\n 0px 12px 16px -4px rgba(10, 13, 18, 0.08)}.video-chip{background-color:rgba(255, 255, 255, 0.4);width:max-content;padding:12px 8px;border-radius:24px;color:#0086C9;font-size:12px}.video-description{color:#414651;font-size:18px;max-width:90%}.product-demo{background-color:#0BA5EC;padding:8px 14px;color:white;border-radius:24px;margin-right:8px;font-size:12px}.video-header{text-align:left;margin-bottom:16px}.external-links{padding:36px 80px}.explore-container{display:grid;grid-template-columns:repeat(3, 1fr)}.explore-items{display:flex;gap:20px;width:100%}.explore-header{color:#252B37;font-size:24px;font-weight:600;letter-spacing:-2%}.explore-desc{font-size:18px;color:#717680;margin-top:4px}.explore-card{background-color:#F4F9FF;box-shadow:0px 4px 12px -8px #0026543D;padding:12px 20px;border-radius:12px;color:#535862;font-size:14px;font-weight:400;transition:all 0.3s ease}.explore-card:hover{box-shadow:0px 3px 3px -1.5px rgba(10, 13, 18, 0.04),\n 0px 8px 8px -4px rgba(10, 13, 18, 0.03),\n 0px 20px 24px -4px rgba(10, 13, 18, 0.08);padding:16px 24px;margin:-4px;transform:translateY(-2px)}.explore-card-header{display:flex;gap:10px}.explore-card-header div{color:#252B37;font-weight:500;font-size:18px}.home-footer{display:flex;justify-content:space-between;padding:36px 80px 0px;color:#717680}.home-footer-links{display:flex;gap:20px}.footer-link-name{color:#252B37;font-weight:400}.footer-link-name:hover{color:#181D27;text-decoration:underline}.home-footer-social{display:flex;gap:8px}.social-link{padding:4px 8px;border-radius:4px}.social-link:hover{background-color:#F8F9FC}.connector-page div[data-component-part=\"card-icon\"]{background-color:#F8F9FC;padding:21px 20px;border-radius:100%;display:inline-flex;align-items:center;justify-content:center}.connector-page div[data-component-part=\"card-icon\"]>*{position:relative;z-index:1}.connector-page .card [data-component-part=\"card-content-container\"]{padding:16px}.card-details{display:flex;gap:6px;align-items:center}.card-logo{width:20px;height:20px;margin:0px}.products-container{max-width:1150px;margin:0 auto;padding:60px 14px 40px}.products-container h1{font-size:30px!important}.products-container [data-as=\"p\"]:first-of-type{display:block;margin-bottom:40px}.product-cards{margin-top:16px;padding-bottom:48px}.product-cards .card [data-component-part=\"card-content\"]{margin-top:4px}.products-container .external-links{padding:64px 0px 36px}.products-container .home-footer{padding:36px 0px 0px}.sdk-api-container{padding:72px 0px;max-width:1300px}.sdk-api-container span[data-as=\"p\"]{display:block;margin-bottom:8px;color:#414651}.sdk-api-container a.link{color:#004CD3!important}.sdk-api-container h3{color:#222244;font-size:20px}.api-header{display:grid;grid-template-columns:repeat(2, 1fr);gap:40px;margin-top:16px;padding-bottom:56px;border-bottom:1px solid #EAECF5}.sdk-api-container .code-group{background-color:#515865}.sdk-api-container .code-group button{color:white!important;font-weight:600;font-size:14px}.sdk-api-container .code-group button .absolute{display:none}.sdk-api-container [data-component-part=\"code-block-root\"]{background-color:#3E444F!important}.sdk-api-container [data-component-part=\"code-block-root\"] pre,.sdk-api-container [data-component-part=\"code-block-root\"] pre .line span{color:white!important}.client-sdks{border:1px solid #E9EAEB;border-radius:8px}.client-header{color:#414651;font-weight:600;padding:24px 24px 0px;background-color:#FAFAFA;border-top-left-radius:8px;border-top-right-radius:8px}.client-sdks [role=\"tablist\"]{margin-bottom:0px!important;display:flex;justify-content:center;gap:100px}.client-sdks [data-component-part=\"tabs-list\"]{padding:10px 24px 0px;background-color:#FAFAFA}.client-sdks [data-active=\"true\"]{border-bottom:3px solid #1570EF}.client-sdks [data-active=\"false\"]{border-bottom:none}.client-sdks [data-component-part=\"tab-button\"]{display:flex;flex-direction:column;color:#181D27!important}.client-sdks [data-component-part=\"tab-button\"] img{width:40px;height:40px}.client-sdks [data-component-part=\"tab-content\"]{background-color:#F5F5F5;padding:10px 24px}.api-header-auth{display:grid;grid-template-columns:repeat(2, 1fr);gap:40px;padding-top:48px;padding-bottom:56px;border-bottom:1px solid #EAECF5}.api-header-auth h2{color:#222244;font-size:20px;font-weight:600;margin-bottom:12px}.sdk-api-container [data-component-part=\"code-group-tab-bar\"] div:first-child span{color:white!important;font-size:14px;font-weight:600;margin-left:8px}.sdk-api-container [data-component-part=\"code-group-tab-bar\"] [data-testid=\"copy-code-button\"] svg{color:white}.sdk-api-container [data-component-part=\"code-group-tab-bar\"] .group{background-color:#252B37;border:1px solid #5B626F;padding:4px;border-radius:4px;color:white}.sdk-api-container [data-component-part=\"code-group-tab-bar\"] .group div svg:first-of-type{display:none!important}.sdk-api-container [data-component-part=\"code-group-tab-bar\"] .group div p{color:white;margin:0px}.sdk-api-container [data-component-part=\"code-group-tab-bar\"] .group div:hover{background-color:transparent}@media (max-width: 1280px){.guide-list{grid-template-columns:repeat(3, 1fr)}.links{max-width:100%}.collate-video,.external-links,.home-footer{padding:32px 56px}.release-banner{padding:40px 52px}}@media (max-width: 1220px){.chips{display:grid;grid-template-columns:repeat(4, 1fr);max-width:auto;justify-items:center}}@media (max-width: 1024px){.release-banner-content{grid-template-columns:repeat(1, 1fr)}.release-banner h2{font-size:28px}.video-content{grid-template-columns:repeat(1, 1fr);gap:28px}.explore-container{grid-template-columns:repeat(1, 1fr);gap:32px}.home-footer{display:grid;grid-template-columns:repeat(3, 1fr);row-gap:20px}.collate-tm{grid-column:span 3/span 3}.home-footer-links{grid-column:span 2/span 2}.home-footer-social{justify-self:flex-end}}@media (max-width: 768px){.page-header{font-size:48px}.chips{grid-template-columns:repeat(2, 1fr);max-width:400px;margin:40px auto 0}.guide-list{grid-template-columns:repeat(2, 1fr)}.links{grid-template-columns:repeat(2, 1fr);justify-items:start;row-gap:40px}.video-container{padding:0 12px;margin:16px auto}.external-links,.home-footer{padding:24px}.home-footer-links{flex-direction:column}}@media (max-width: 640px){.chips{grid-template-columns:repeat(1, 1fr);max-width:auto;justify-items:center}.release-banner{padding:40px 20px}.guide-list{grid-template-columns:repeat(1, 1fr)}.highlight-cards{grid-template-columns:repeat(1, 1fr)}.links{grid-template-columns:repeat(1, 1fr)}.collate-video{padding:24px}.explore-items{flex-direction:column}}.chat-assistant-floating-input::before{display:none!important}"},{"filePath":"snippets/components/CodeLayout/CodeLayout.css","content":".code-layout{display:grid;grid-template-columns:1fr 1fr;gap:2rem;margin:2rem 0;align-items:start;width:100%}.code-layout h2{margin-top:0px}.code-layout-sticky{position:-webkit-sticky;position:sticky;top:132px;align-self:flex-start;max-height:calc(100vh - 132px);overflow-y:auto;z-index:10}"},{"filePath":"ai-2-0/snippets/components/CodeLayout/CodeLayout.css","content":".code-layout{display:grid;grid-template-columns:1fr 1fr;gap:2rem;margin:2rem 0;align-items:start;width:100%}.code-layout h2{margin-top:0px}.code-layout-sticky{position:-webkit-sticky;position:sticky;top:132px;align-self:flex-start;max-height:calc(100vh - 132px);overflow-y:auto;z-index:10}"},{"filePath":"ai-2-0/snippets/components/CodePreview.css","content":".split-layout{display:grid;grid-template-columns:1fr 1fr;gap:2rem;margin:2rem 0;align-items:start}@media (max-width: 768px){.split-layout{grid-template-columns:1fr;gap:1rem}}.code-content .code-block [data-component-part=\"code-block-root\"]{background-color:#0b1e3d!important}.content-panel{display:flex;flex-direction:column;gap:1.5rem;padding-right:1rem}.content-section{padding:0.5rem 1rem;border-left:2px solid transparent;border-radius:6px;cursor:pointer;position:relative;box-sizing:border-box;transition:background 0.25s ease,\n border-color 0.25s ease,\n box-shadow 0.25s ease}.content-section:hover{background:linear-gradient(\n 90deg,\n rgba(176, 176, 176, 0.08) 0%,\n rgba(176, 176, 176, 0.03) 100%\n );border-left-color:rgba(176, 176, 176, 0.5)}.content-section.active{background:linear-gradient(\n 90deg,\n rgba(176, 176, 176, 0.15) 0%,\n rgba(176, 176, 176, 0.05) 100%\n );border-left-color:#b0b0b0;box-shadow:0 2px 8px rgba(176, 176, 176, 0.1),\n inset 0 0 20px rgba(176, 176, 176, 0.05);color:rgb(63, 65, 69)}.content-section.active::before{content:'';position:absolute;left:0;top:0;bottom:0;width:2px;background:linear-gradient(\n 180deg,\n #c0c0c0 0%,\n #b0b0b0 50%,\n #a0a0a0 100%\n )}.content-section h4{margin:0 0 0.75rem 0;font-size:1rem;font-weight:600;color:#1a1a1a}.content-section p{margin:0.5rem 0;line-height:1.6;color:#4a4a4a}.content-section code{background:rgba(0, 0, 0, 0.05);padding:0.2em 0.4em;border-radius:3px;font-size:0.9em}.code-panel{position:sticky;top:calc(var(--navbar-height, 64px) + 6rem);height:calc(\n 100vh - var(--navbar-height, 64px) - 6rem\n );display:flex;flex-direction:column;border:1px solid #e5e7eb;border-radius:8px;overflow:hidden;background:#1e1e1e;box-shadow:0 4px 6px rgba(0, 0, 0, 0.1)}.code-panel [data-component-part=\"code-block-root\"]{padding:0rem 1rem}.code-panel .code-block{margin:0}.code-header{display:flex;justify-content:space-between;align-items:center;padding:0.4rem 1rem;background:#0b1e3d;border-bottom:1px solid #404040;color:white;font-size:0.875rem;font-family:'Monaco', 'Menlo', 'Ubuntu Mono', monospace}.copy-btn{display:flex;align-items:center;gap:0.5rem;padding:0.375rem 0.75rem;background:transparent;border:1px solid #404040;border-radius:4px;color:#a0a0a0;cursor:pointer;transition:all 0.2s ease;font-size:0.875rem}.copy-btn:hover{background:#404040;border-color:#606060;color:#fff}.copy-btn svg{width:16px;height:16px}.copy-btn .icon-check{display:none}.copy-btn[data-copied=\"true\"] .icon-copy{display:none}.copy-btn[data-copied=\"true\"] .icon-check{display:block;color:#10b981}.code-content{position:relative;flex:1 1 auto;min-height:0;overflow-y:auto;overflow-x:auto;background:#0b1e3d;scroll-behavior:smooth;padding:14px 0px}.code-content::-webkit-scrollbar{width:8px;height:8px}.code-content::-webkit-scrollbar-track{background:#2d2d2d}.code-content::-webkit-scrollbar-thumb{background:#404040;border-radius:4px}.code-content::-webkit-scrollbar-thumb:hover{background:#606060}.code-content pre{margin:0;padding:0rem 1rem;background:transparent;color:#d4d4d4;font-family:'Monaco', 'Menlo', 'Ubuntu Mono', monospace;font-size:0.875rem;line-height:1.6;white-space:pre;word-wrap:normal;overflow-wrap:normal;position:relative}.code-content pre code{background:transparent;padding:0;color:inherit;font-size:inherit;border-radius:0;display:block;white-space:pre}.code-line{display:block;padding-left:1rem;padding-right:1rem;margin-left:-1rem;margin-right:-1rem;transition:all 0.2s ease;position:relative;white-space:pre;line-height:inherit;border-left:2px solid transparent}.code-line::after{content:'\\a';white-space:pre}.code-line.highlighted{background:rgba(200, 200, 200, 0.15)!important;border-left:2px solid #d0d0d0;padding-left:calc(1rem - 2px);min-height:1.5em}.code-line.highlighted::before{content:'';position:absolute;left:0;top:0;bottom:0;width:2px;background:#d0d0d0;z-index:1}.code-line.highlighted+.code-line.highlighted{border-top:none}.code-line.highlighted:not(.code-line.highlighted+.code-line.highlighted){border-top-left-radius:4px}.code-line.highlighted:not(:has(+.code-line.highlighted)){border-bottom-left-radius:4px}.line-number{display:inline-block;min-width:2.5em;padding-right:1em;margin-right:0.5em;text-align:right;color:#858585;user-select:none;border-right:1px solid #404040}@media (prefers-color-scheme: dark){.content-section p{color:#c0c0c0}.content-section code{background:rgba(255, 255, 255, 0.1)}.code-panel{border-color:#404040}}@media (max-width: 768px){.code-panel{position:relative;top:0;max-height:400px}.split-layout{grid-template-columns:1fr}}.code-content [data-testid=\"copy-code-button\"]{display:none!important}.code-content #ask-ai-code-block-button{display:none!important}div[data-fade-overlay=\"true\"]{--fade-color-light: transparent !important;--fade-color-dark: transparent !important;display:none!important}:has([data-floating-buttons])>[data-component-part=code-block-root] pre>code{padding-right:0px!important}@media (max-width: 768px){.code-panel{position:relative;top:0;height:400px}}"},{"filePath":"ai-2-0/snippets/components/ConnectorDetailsHeader/ConnectorDetailsHeader.css","content":".container{margin:48px 0px!important;display:flex;flex-direction:column;gap:6px}.Heading{display:flex;justify-content:space-between;padding-bottom:8px;border-bottom:1px solid var(--default-border-color)}.ConnectorName{font-size:32px;font-weight:700;margin-bottom:0px}.PlatformDetails{display:flex;align-items:center;gap:4px;font-size:14px;color:var(--gray-text-color)}.PlatformIcon{padding:4px;background-color:var(--connector-icon-bg-color);border:1px solid var(--default-border-color);border-radius:12px}.ImageContainer{background-color:var(--connector-icon-bg-color);padding:12px;border:1px solid var(--default-border-color);border-radius:28px}.IconContainer{background-color:#F8F9FC;padding:16px;border-radius:50%;display:inline-flex;align-items:center;justify-content:center;width:64px;height:64px;flex-shrink:0}.ConnectorIcon{width:32px!important;height:32px!important;object-fit:contain;display:block;margin:0}.FeaturesHeading{font-size:14px;color:var(--gray-text-color)}.SubHeading{display:flex;flex-direction:column;gap:8px}.FeaturesList{display:flex;flex-wrap:wrap;gap:12px}.FeatureTag{padding:4px 10px;font-size:12px;border-radius:14px;width:fit-content;display:flex;align-items:center;gap:4px}.AvailableFeature{color:var(--green-tag-color);border:1px solid var(--green-tag-color);background-color:var(--green-tag-bg-color)}.UnavailableFeature{color:var(--orange-tag-color);border:1px solid var(--orange-tag-color);background-color:var(--orange-tag-bg-color)}.StageBadge{font-size:10px;height:auto;color:var(--green-tag-color)}"},{"filePath":"ai-2-0/snippets/components/ConnectorFilter/ConnectorFilter.css","content":".connector-filter{--connector-filter-accent: #1570ef;position:sticky;top:0;z-index:20;margin:20px 0 28px;padding:16px;border:1px solid var(--default-border-color, #e5e7eb);border-radius:8px;background-color:var(--background-color, #fff);box-shadow:0 2px 8px rgba(15, 23, 42, 0.06)}.connector-filter-row{display:flex;flex-wrap:wrap;align-items:flex-end;gap:12px}.connector-filter-field{display:flex;flex-direction:column;gap:6px;flex:1 1 160px;min-width:140px}.connector-filter-search-field{flex:1 1 170px;min-width:140px}.connector-filter-field label{font-size:14px;font-weight:600;color:var(--default-text-color, #374151)}.connector-filter-search{display:flex;align-items:center;gap:8px;height:36px;padding:0 10px;border:1px solid var(--select-border-color, #d1d5db);border-radius:6px;background-color:var(--background-color, #fff);color:var(--gray-text-color, #6b7280)}.connector-filter-search:focus-within{border-color:var(--connector-filter-accent);box-shadow:0 0 0 2px color-mix(in srgb, var(--connector-filter-accent) 20%, transparent)}.connector-filter-search svg{flex-shrink:0}.connector-filter-search input{flex:1;min-width:0;border:none;outline:none;background:transparent;font-size:13px;color:var(--default-text-color, #111827)}.connector-filter-dropdown{position:relative}.connector-filter-trigger{display:flex;align-items:center;justify-content:space-between;gap:8px;width:100%;height:36px;padding:0 10px;border:1px solid var(--select-border-color, #d1d5db);border-radius:6px;background-color:var(--background-color, #fff);color:var(--default-text-color, #111827);font-size:13px;cursor:pointer;text-align:left}.connector-filter-trigger:hover{border-color:var(--connector-filter-accent)}.connector-filter-trigger[aria-expanded=\"true\"]{border-color:var(--connector-filter-accent);box-shadow:0 0 0 2px color-mix(in srgb, var(--connector-filter-accent) 20%, transparent)}.connector-filter-trigger span{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.connector-filter-chevron{flex-shrink:0;color:var(--gray-text-color, #6b7280);transition:transform 0.15s ease}.connector-filter-chevron-open{transform:rotate(180deg);color:var(--connector-filter-accent)}.connector-filter-menu{position:absolute;top:calc(100% + 6px);left:0;right:0;z-index:30;max-height:320px;overflow-y:auto;margin:0;padding:6px;list-style:none;border:1px solid var(--default-border-color, #e5e7eb);border-radius:8px;background-color:var(--background-color, #fff);box-shadow:0 8px 24px rgba(15, 23, 42, 0.12)}.connector-filter-menu li{list-style:none}.connector-filter-menu li::marker,.connector-filter-menu li::before{content:none}.connector-filter-menu li[role=\"option\"]{padding:7px 10px;border-radius:5px;font-size:13px;color:var(--default-text-color, #111827);cursor:pointer}.connector-filter-menu li[role=\"option\"]:hover{background-color:var(--primary-background-color, rgba(21, 112, 239, 0.08))}.connector-filter-menu li[role=\"option\"].active{background-color:var(--primary-background-color, rgba(21, 112, 239, 0.1));color:var(--connector-filter-accent);font-weight:600}.connector-filter-group-label{padding:6px 10px 4px;font-size:11px;font-weight:700;text-transform:uppercase;letter-spacing:0.04em;color:var(--gray-text-color, #9ca3af)}.connector-filter-reset{flex-shrink:0;margin-left:auto;height:36px;padding:0 14px;border:1px solid var(--connector-filter-accent);border-radius:6px;background-color:transparent;color:var(--connector-filter-accent);font-size:13px;font-weight:600;cursor:pointer}.connector-filter-reset:hover{background-color:color-mix(in srgb, var(--connector-filter-accent) 10%, transparent)}"},{"filePath":"ai-2-0/snippets/components/ConnectorGrid/Integrations.css","content":".no-scrollbar::-webkit-scrollbar{display:none}.no-scrollbar{-ms-overflow-style:none;scrollbar-width:none}.integrations-section{padding:3rem 1rem 9rem;max-width:1300px;margin:0 auto}.integrations-card{background:#FAFAFA;border-radius:12px;border:1px solid #EAECF5;display:flex;height:660px;overflow:hidden;position:relative;padding:40px 40px 40px 0px}.integrations-mobile-header{display:none;width:100%;background:#ffffff;border-bottom:1px solid #d9daee;padding:32px;font-size:20px;justify-content:center;align-items:center;gap:12px;position:sticky;top:0;z-index:15;cursor:pointer}.arrow{transition:transform 0.3s ease}.arrow.open{transform:rotate(180deg)}.arrow-down{width:10px;height:10px}.integrations-sidebar{width:220px;border-right:1px solid #EAECF5;display:flex;flex-direction:column;position:sticky;top:0;z-index:5}.sidebar-item{display:block;width:100%;padding:12px 22px;font-size:16px;color:#535862;cursor:pointer;white-space:nowrap;flex-shrink:0;text-align:right;font-weight:500;border-right:2px solid transparent}.sidebar-item:hover{color:#414651;border-right:2px solid #D5D9EB}.sidebar-item.active{border-right:2px solid #004CD3;font-weight:600;color:#004CD3}.integrations-grid{flex:1;padding:20px 32px;overflow-y:auto;display:grid;gap:20px;align-content:flex-start}.integrations-grid.desktop{grid-template-columns:repeat(auto-fill, minmax(200px, 1fr))}.integrations-grid.mobile{display:none}.integration-card{max-height:110px;text-decoration:none;display:flex;align-items:center;gap:12px;background-color:white;box-shadow:0px 4px 12px -1px #0A0D1214;border-radius:12px;padding:12px 20px;box-sizing:border-box;transition:all 0.3s ease}.integration-card span{color:#181D27;font-weight:500;font-size:16px;line-height:120%}a.integration-card span:hover{text-decoration:none}a.integration-card:hover{box-shadow:0px 3px 3px -1.5px #0A0D120A,\n 0px 8px 8px -4px #0A0D1208,\n 0px 20px 24px -4px #0A0D1214;padding:16px 24px;margin:-4px;text-decoration:none;transform:translateY(-2px)}.integration-card img{width:32px;height:32px;object-fit:contain;flex-shrink:0}.load-more{grid-column:span 2;padding:24px;font-size:20px;background:#ffffff;border:none;cursor:pointer}@media (max-width: 1024px){.integrations-card{flex-direction:column;height:auto;padding:0px;overflow:auto}.integrations-mobile-header{display:flex}.integrations-sidebar{display:none;width:100%;position:absolute;top:98px;left:0;right:0;border-right:none;border-bottom:1px solid #d9daee;background:#ffffff;overflow-y:scroll}.integrations-sidebar.open{display:block}.sidebar-item{text-align:center}.sidebar-item.active{border-right:none}.integrations-grid.desktop{display:none}.integrations-grid.mobile{display:grid;grid-template-columns:repeat(2, 1fr);padding:24px}}"},{"filePath":"ai-2-0/snippets/components/ReleaseCarousel/ReleaseCarousel.css","content":".release-carousel{position:relative}.release-carousel-viewport{overflow:hidden}.release-carousel-content [data-as=\"p\"]{display:block;margin-bottom:24px;color:#344054;font-size:18px}.release-carousel-content [data-as=\"p\"] strong{color:#181D27;font-weight:700}.release-carousel-content a{display:inline-block}.release-carousel-title-row{display:flex;align-items:center;gap:12px;margin-bottom:16px}.release-carousel-content .release-carousel-title-row h2{margin:0}.release-carousel-eyebrow{display:inline-block;flex-shrink:0;background-color:#F0F9FF;color:#0BA5EC;padding:4px 14px;border-radius:100px;font-size:13px;font-weight:600;letter-spacing:0.02em;text-transform:uppercase}.release-carousel-content.slide-next{animation:release-carousel-slide-next 0.45s ease}.release-carousel-content.slide-prev{animation:release-carousel-slide-prev 0.45s ease}@keyframes release-carousel-slide-next{from{opacity:0;transform:translateX(60px)}to{opacity:1;transform:translateX(0)}}@keyframes release-carousel-slide-prev{from{opacity:0;transform:translateX(-60px)}to{opacity:1;transform:translateX(0)}}.release-carousel-image{width:100%;max-width:1200px;display:block;border:3px solid #BED2FB;border-radius:16px;box-shadow:0px 2px 2px -1px #0A0D120A,\n 0px 4px 6px -2px #0A0D1208,\n 0px 12px 16px -4px #0A0D1214;cursor:zoom-in}.release-carousel-lightbox{position:fixed;inset:0;z-index:1000;display:flex;align-items:center;justify-content:center;padding:40px;background-color:rgba(16, 24, 40, 0.85)}.release-carousel-lightbox-image{max-width:100%;max-height:100%;display:block;border-radius:12px;box-shadow:0px 12px 16px -4px #0A0D1214;cursor:default}.release-carousel-lightbox-close{position:absolute;top:24px;right:24px;display:flex;align-items:center;justify-content:center;width:40px;height:40px;border-radius:50%;border:1px solid rgba(255, 255, 255, 0.3);background-color:rgba(255, 255, 255, 0.1);color:white;cursor:pointer;transition:background-color 0.15s ease}.release-carousel-lightbox-close:hover{background-color:rgba(255, 255, 255, 0.2)}.release-carousel .carousel-arrow{position:absolute;top:50%;transform:translateY(-50%);display:flex;align-items:center;justify-content:center;width:40px;height:40px;border-radius:50%;border:1px solid #BED2FB;background-color:white;color:#181D27;box-shadow:0px 2px 2px -1px #0A0D120A,\n 0px 4px 6px -2px #0A0D1208,\n 0px 12px 16px -4px #0A0D1214;cursor:pointer;transition:background-color 0.15s ease}.release-carousel .carousel-arrow:hover{background-color:#EFF4FF}.release-carousel .carousel-arrow-prev{left:16px}.release-carousel .carousel-arrow-next{right:16px}.release-carousel .carousel-dots{display:flex;justify-content:center;gap:8px;margin-top:16px}.release-carousel .carousel-dot{width:8px;height:8px;border-radius:50%;border:none;background-color:#BED2FB;padding:0;cursor:pointer;transition:background-color 0.15s ease, transform 0.15s ease}.release-carousel .carousel-dot.active{background-color:#1570EF;transform:scale(1.2)}@media (max-width: 1024px){.release-carousel .carousel-arrow-prev{left:4px}.release-carousel .carousel-arrow-next{right:4px}}@media (max-width: 768px){.release-carousel .carousel-arrow{width:32px;height:32px}}"}]}
{"page":{"pagePath":"api-reference/data-assets/api-endpoints/create","slug":"/api-reference/data-assets/api-endpoints/create","pageMetadata":{"title":"Create an API Endpoint","description":"Create a new API endpoint entity with HTTP method, parameters, responses, owners, tags, and metadata within an API collection using the Collate REST API.","sidebarTitle":"Create API Endpoint","api":"POST /v1/apiEndpoints","href":"/api-reference/data-assets/api-endpoints/create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a new API endpoint entity with HTTP method, parameters, responses, owners, tags, and metadata within an API collection using the Collate REST API.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,Note,ParamField,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`create-an-api-endpoint`,children:`Create an API Endpoint`}),`\n`,_jsx(_components.p,{children:`Create a new API endpoint within an API collection.`}),`\n`,_jsx(Heading,{level:`2`,id:`body-parameters`,children:`Body Parameters`}),`\n`,_jsx(ParamField,{body:`name`,type:`string`,required:true,id:`param-name`,children:_jsx(_components.p,{children:`Name of the API endpoint. Must be unique within the parent API collection.`})}),`\n`,_jsx(ParamField,{body:`apiCollection`,type:`string`,required:true,id:`param-api-collection`,children:_jsxs(_components.p,{children:[`Fully qualified name of the parent APICollection, for example `,_jsx(_components.code,{children:`sample_api_service.pet`}),`.`]})}),`\n`,_jsx(ParamField,{body:`endpointURL`,type:`string`,id:`param-endpoint-url`,children:_jsxs(_components.p,{children:[`URL for the API endpoint, for example `,_jsx(_components.code,{children:`https://petstore3.swagger.io/#/pet/addPet`}),`.`]})}),`\n`,_jsx(ParamField,{body:`requestMethod`,type:`string`,id:`param-request-method`,children:_jsxs(_components.p,{children:[`HTTP request method: `,_jsx(_components.code,{children:`GET`}),`, `,_jsx(_components.code,{children:`POST`}),`, `,_jsx(_components.code,{children:`PUT`}),`, `,_jsx(_components.code,{children:`PATCH`}),`, or `,_jsx(_components.code,{children:`DELETE`}),`.`]})}),`\n`,_jsxs(ParamField,{body:`requestSchema`,type:`object`,id:`param-request-schema`,children:[_jsx(_components.p,{children:`Schema describing the request body.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`schemaType`,type:`string`,id:`param-schema-type`,children:_jsxs(_components.p,{children:[`Type of schema, for example `,_jsx(_components.code,{children:`JSON`}),`.`]})}),_jsxs(ParamField,{body:`schemaFields`,type:`array`,id:`param-schema-fields`,children:[_jsx(_components.p,{children:`Array of field objects describing the schema.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`name`,type:`string`,id:`param-name-1`,children:_jsx(_components.p,{children:`Name of the field.`})}),_jsx(ParamField,{body:`dataType`,type:`string`,id:`param-data-type`,children:_jsxs(_components.p,{children:[`Data type of the field, for example `,_jsx(_components.code,{children:`INT`}),`, `,_jsx(_components.code,{children:`STRING`}),`, `,_jsx(_components.code,{children:`OBJECT`}),`.`]})}),_jsx(ParamField,{body:`description`,type:`string`,id:`param-description`,children:_jsx(_components.p,{children:`Description of the field.`})})]})]})]})]}),`\n`,_jsxs(ParamField,{body:`responseSchema`,type:`object`,id:`param-response-schema`,children:[_jsx(_components.p,{children:`Schema describing the response body.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`schemaType`,type:`string`,id:`param-schema-type-1`,children:_jsxs(_components.p,{children:[`Type of schema, for example `,_jsx(_components.code,{children:`JSON`}),`.`]})}),_jsxs(ParamField,{body:`schemaFields`,type:`array`,id:`param-schema-fields-1`,children:[_jsx(_components.p,{children:`Array of field objects describing the schema.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`name`,type:`string`,id:`param-name-2`,children:_jsx(_components.p,{children:`Name of the field.`})}),_jsx(ParamField,{body:`dataType`,type:`string`,id:`param-data-type-1`,children:_jsx(_components.p,{children:`Data type of the field.`})}),_jsx(ParamField,{body:`description`,type:`string`,id:`param-description-1`,children:_jsx(_components.p,{children:`Description of the field.`})})]})]})]})]}),`\n`,_jsx(ParamField,{body:`displayName`,type:`string`,id:`param-display-name`,children:_jsx(_components.p,{children:`Human-readable display name for the API endpoint.`})}),`\n`,_jsx(ParamField,{body:`description`,type:`string`,id:`param-description-2`,children:_jsx(_components.p,{children:`Description of the API endpoint in Markdown format.`})}),`\n`,_jsxs(ParamField,{body:`owners`,type:`array`,id:`param-owners`,children:[_jsx(_components.p,{children:`Array of owner references (users or teams) to assign to the API endpoint.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`id`,type:`string`,id:`param-id`,children:_jsx(_components.p,{children:`UUID of the owner entity.`})}),_jsx(ParamField,{body:`type`,type:`string`,id:`param-type`,children:_jsxs(_components.p,{children:[`Type of owner entity, for example `,_jsx(_components.code,{children:`user`}),`, `,_jsx(_components.code,{children:`team`}),`.`]})}),_jsx(ParamField,{body:`name`,type:`string`,id:`param-name-3`,children:_jsx(_components.p,{children:`Name of the owner entity.`})})]})]}),`\n`,_jsx(ParamField,{body:`domains`,type:`array`,id:`param-domains`,children:_jsx(_components.p,{children:`Fully qualified names of the domains to assign for governance purposes.`})}),`\n`,_jsxs(ParamField,{body:`tags`,type:`array`,id:`param-tags`,children:[_jsx(_components.p,{children:`Array of classification tags to apply to the API endpoint.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`tagFQN`,type:`string`,required:true,id:`param-tag-fqn`,children:_jsx(_components.p,{children:`Fully qualified name of the tag.`})}),_jsx(ParamField,{body:`labelType`,type:`string`,id:`param-label-type`,children:_jsxs(_components.p,{children:[`Type of label, for example `,_jsx(_components.code,{children:`Manual`}),`, `,_jsx(_components.code,{children:`Derived`}),`, `,_jsx(_components.code,{children:`Propagated`}),`.`]})}),_jsx(ParamField,{body:`state`,type:`string`,id:`param-state`,children:_jsxs(_components.p,{children:[`State of the tag, for example `,_jsx(_components.code,{children:`Suggested`}),`, `,_jsx(_components.code,{children:`Confirmed`}),`.`]})})]})]}),`\n`,_jsx(ParamField,{body:`extension`,type:`object`,id:`param-extension`,children:_jsx(_components.p,{children:`Custom property values defined by your organization’s metadata schema.`})}),`\n`,`\n`,`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`returns`,children:`Returns`}),`\n`,_jsx(_components.p,{children:`Returns the created API endpoint object with all specified properties and system-generated fields.`}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id-1`,children:_jsx(_components.p,{children:`Unique identifier for the API endpoint (UUID format).`})}),`\n`,_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-4`,children:_jsx(_components.p,{children:`API endpoint name.`})}),`\n`,_jsx(ResponseField,{name:`fullyQualifiedName`,type:`string`,id:`param-fully-qualified-name`,children:_jsxs(_components.p,{children:[`Fully qualified name in format `,_jsx(_components.code,{children:`service.collection.endpointName`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`displayName`,type:`string`,id:`param-display-name-1`,children:_jsx(_components.p,{children:`Human-readable display name.`})}),`\n`,_jsx(ResponseField,{name:`description`,type:`string`,id:`param-description-3`,children:_jsx(_components.p,{children:`Description of the API endpoint in Markdown format.`})}),`\n`,_jsx(ResponseField,{name:`endpointURL`,type:`string`,id:`param-endpoint-url-1`,children:_jsx(_components.p,{children:`URL for the API endpoint.`})}),`\n`,_jsx(ResponseField,{name:`requestMethod`,type:`string`,id:`param-request-method-1`,children:_jsx(_components.p,{children:`HTTP request method (GET, POST, PUT, PATCH, DELETE).`})}),`\n`,_jsxs(ResponseField,{name:`requestSchema`,type:`object`,id:`param-request-schema-1`,children:[_jsx(_components.p,{children:`Schema describing the request body.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`schemaType`,type:`string`,id:`param-schema-type-2`,children:_jsx(_components.p,{children:`Type of schema, for example JSON.`})}),_jsx(ResponseField,{name:`schemaFields`,type:`array`,id:`param-schema-fields-2`,children:_jsx(_components.p,{children:`Array of field definitions.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`responseSchema`,type:`object`,id:`param-response-schema-1`,children:[_jsx(_components.p,{children:`Schema describing the response body.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`schemaType`,type:`string`,id:`param-schema-type-3`,children:_jsx(_components.p,{children:`Type of schema, for example JSON.`})}),_jsx(ResponseField,{name:`schemaFields`,type:`array`,id:`param-schema-fields-3`,children:_jsx(_components.p,{children:`Array of field definitions.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`service`,type:`object`,id:`param-service`,children:[_jsx(_components.p,{children:`Reference to the parent API service.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id-2`,children:_jsx(_components.p,{children:`UUID of the API service.`})}),_jsx(ResponseField,{name:`type`,type:`string`,id:`param-type-1`,children:_jsxs(_components.p,{children:[`Type of entity (always `,_jsx(_components.code,{children:`apiService`}),`).`]})}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-5`,children:_jsx(_components.p,{children:`Name of the API service.`})})]})]}),`\n`,_jsx(ResponseField,{name:`serviceType`,type:`string`,id:`param-service-type`,children:_jsx(_components.p,{children:`Type of API service, for example Rest.`})}),`\n`,_jsxs(ResponseField,{name:`owners`,type:`array`,optional:true,id:`param-owners-1`,children:[_jsx(_components.p,{children:`List of owners assigned to the API endpoint.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id-3`,children:_jsx(_components.p,{children:`UUID of the owner entity.`})}),_jsx(ResponseField,{name:`type`,type:`string`,id:`param-type-2`,children:_jsxs(_components.p,{children:[`Type of owner entity, for example `,_jsx(_components.code,{children:`user`}),`, `,_jsx(_components.code,{children:`team`}),`.`]})}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-6`,children:_jsx(_components.p,{children:`Name of the owner entity.`})})]})]}),`\n`,_jsx(ResponseField,{name:`domains`,type:`array`,optional:true,id:`param-domains-1`,children:_jsx(_components.p,{children:`Domain assignments for governance.`})}),`\n`,_jsxs(ResponseField,{name:`tags`,type:`array`,optional:true,id:`param-tags-1`,children:[_jsx(_components.p,{children:`Classification tags applied to the API endpoint.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`tagFQN`,type:`string`,id:`param-tag-fqn-1`,children:_jsx(_components.p,{children:`Fully qualified name of the tag.`})}),_jsx(ResponseField,{name:`labelType`,type:`string`,id:`param-label-type-1`,children:_jsxs(_components.p,{children:[`Type of label, for example `,_jsx(_components.code,{children:`Manual`}),`, `,_jsx(_components.code,{children:`Derived`}),`, `,_jsx(_components.code,{children:`Propagated`}),`.`]})}),_jsx(ResponseField,{name:`state`,type:`string`,id:`param-state-1`,children:_jsxs(_components.p,{children:[`State of the tag, for example `,_jsx(_components.code,{children:`Suggested`}),`, `,_jsx(_components.code,{children:`Confirmed`}),`.`]})})]})]}),`\n`,_jsx(ResponseField,{name:`extension`,type:`object`,optional:true,id:`param-extension-1`,children:_jsx(_components.p,{children:`Custom property values defined by your organization’s metadata schema.`})}),`\n`,_jsx(ResponseField,{name:`version`,type:`number`,id:`param-version`,children:_jsx(_components.p,{children:`Version number for the entity (starts at 0.1).`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`create-or-update-put`,children:`Create or Update (PUT)`}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`PUT /v1/apiEndpoints`}),` instead of `,_jsx(_components.code,{children:`POST`}),` to perform an upsert. If an API endpoint with the same `,_jsx(_components.code,{children:`fullyQualifiedName`}),` already exists, it will be updated; otherwise, a new API endpoint is created. The request body is the same as `,_jsx(_components.code,{children:`POST`}),`.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` PUT`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"{base_url}/api/v1/apiEndpoints\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer {access_token}\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{ ... same body as POST ... }'`})]}),`\n`]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`PUT`}),` will not return a `,_jsx(_components.code,{children:`409`}),` conflict error if the entity already exists — it will update the existing entity instead. However, for certain fields (such as description, tags, owners, and custom properties), `,_jsx(_components.code,{children:`PUT`}),` preserves an already-populated value instead of overwriting it with an empty or omitted one — the exact behavior depends on the field and the calling user or bot’s permissions, not a blanket rule. See `,_jsx(_components.a,{href:`/api-reference/entity-updates`,children:`Entity Update Behavior`}),` for the full preserve/merge rules. Use `,_jsx(_components.code,{children:`PATCH`}),` to intentionally replace an existing value.`]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`bulk-create-or-update-put`,children:`Bulk Create or Update (PUT)`}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`PUT /v1/apiEndpoints/bulk`}),` to create or update multiple API endpoints in a single request. The request body is an array of create request objects.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` PUT`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"{base_url}/api/v1/apiEndpoints/bulk\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer {access_token}\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '[`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` { \"name\": \"addPet\", \"apiCollection\": \"sample_api_service.pet\", \"requestMethod\": \"POST\" },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` { \"name\": \"getPet\", \"apiCollection\": \"sample_api_service.pet\", \"requestMethod\": \"GET\" }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ]'`})}),`\n`]})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`error-handling`,children:`Error Handling`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Error Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`BAD_REQUEST`})}),_jsx(_components.td,{children:`Invalid request body or missing required fields`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`UNAUTHORIZED`})}),_jsx(_components.td,{children:`Invalid or missing authentication token`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`FORBIDDEN`})}),_jsx(_components.td,{children:`User lacks permission to create API endpoints`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`ENTITY_ALREADY_EXISTS`})}),_jsx(_components.td,{children:`API endpoint with same name already exists in collection (POST only)`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create an API Endpoint","description":"Create a new API endpoint entity with HTTP method, parameters, responses, owners, tags, and metadata within an API collection using the Collate REST API.","sidebarTitle":"Create API Endpoint","api":"POST /v1/apiEndpoints","href":"/api-reference/data-assets/api-endpoints/create"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,Note,ParamField,RequestExample,ResponseExample,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`create-an-api-endpoint`,children:`Create an API Endpoint`}),`\n`,_jsx(_components.p,{children:`Create a new API endpoint within an API collection.`}),`\n`,_jsx(Heading,{level:`2`,id:`body-parameters`,children:`Body Parameters`}),`\n`,_jsx(ParamField,{body:`name`,type:`string`,required:true,id:`param-name`,children:_jsx(_components.p,{children:`Name of the API endpoint. Must be unique within the parent API collection.`})}),`\n`,_jsx(ParamField,{body:`apiCollection`,type:`string`,required:true,id:`param-api-collection`,children:_jsxs(_components.p,{children:[`Fully qualified name of the parent APICollection, for example `,_jsx(_components.code,{children:`sample_api_service.pet`}),`.`]})}),`\n`,_jsx(ParamField,{body:`endpointURL`,type:`string`,id:`param-endpoint-url`,children:_jsxs(_components.p,{children:[`URL for the API endpoint, for example `,_jsx(_components.code,{children:`https://petstore3.swagger.io/#/pet/addPet`}),`.`]})}),`\n`,_jsx(ParamField,{body:`requestMethod`,type:`string`,id:`param-request-method`,children:_jsxs(_components.p,{children:[`HTTP request method: `,_jsx(_components.code,{children:`GET`}),`, `,_jsx(_components.code,{children:`POST`}),`, `,_jsx(_components.code,{children:`PUT`}),`, `,_jsx(_components.code,{children:`PATCH`}),`, or `,_jsx(_components.code,{children:`DELETE`}),`.`]})}),`\n`,_jsxs(ParamField,{body:`requestSchema`,type:`object`,id:`param-request-schema`,children:[_jsx(_components.p,{children:`Schema describing the request body.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`schemaType`,type:`string`,id:`param-schema-type`,children:_jsxs(_components.p,{children:[`Type of schema, for example `,_jsx(_components.code,{children:`JSON`}),`.`]})}),_jsxs(ParamField,{body:`schemaFields`,type:`array`,id:`param-schema-fields`,children:[_jsx(_components.p,{children:`Array of field objects describing the schema.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`name`,type:`string`,id:`param-name-1`,children:_jsx(_components.p,{children:`Name of the field.`})}),_jsx(ParamField,{body:`dataType`,type:`string`,id:`param-data-type`,children:_jsxs(_components.p,{children:[`Data type of the field, for example `,_jsx(_components.code,{children:`INT`}),`, `,_jsx(_components.code,{children:`STRING`}),`, `,_jsx(_components.code,{children:`OBJECT`}),`.`]})}),_jsx(ParamField,{body:`description`,type:`string`,id:`param-description`,children:_jsx(_components.p,{children:`Description of the field.`})})]})]})]})]}),`\n`,_jsxs(ParamField,{body:`responseSchema`,type:`object`,id:`param-response-schema`,children:[_jsx(_components.p,{children:`Schema describing the response body.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`schemaType`,type:`string`,id:`param-schema-type-1`,children:_jsxs(_components.p,{children:[`Type of schema, for example `,_jsx(_components.code,{children:`JSON`}),`.`]})}),_jsxs(ParamField,{body:`schemaFields`,type:`array`,id:`param-schema-fields-1`,children:[_jsx(_components.p,{children:`Array of field objects describing the schema.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`name`,type:`string`,id:`param-name-2`,children:_jsx(_components.p,{children:`Name of the field.`})}),_jsx(ParamField,{body:`dataType`,type:`string`,id:`param-data-type-1`,children:_jsx(_components.p,{children:`Data type of the field.`})}),_jsx(ParamField,{body:`description`,type:`string`,id:`param-description-1`,children:_jsx(_components.p,{children:`Description of the field.`})})]})]})]})]}),`\n`,_jsx(ParamField,{body:`displayName`,type:`string`,id:`param-display-name`,children:_jsx(_components.p,{children:`Human-readable display name for the API endpoint.`})}),`\n`,_jsx(ParamField,{body:`description`,type:`string`,id:`param-description-2`,children:_jsx(_components.p,{children:`Description of the API endpoint in Markdown format.`})}),`\n`,_jsxs(ParamField,{body:`owners`,type:`array`,id:`param-owners`,children:[_jsx(_components.p,{children:`Array of owner references (users or teams) to assign to the API endpoint.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`id`,type:`string`,id:`param-id`,children:_jsx(_components.p,{children:`UUID of the owner entity.`})}),_jsx(ParamField,{body:`type`,type:`string`,id:`param-type`,children:_jsxs(_components.p,{children:[`Type of owner entity, for example `,_jsx(_components.code,{children:`user`}),`, `,_jsx(_components.code,{children:`team`}),`.`]})}),_jsx(ParamField,{body:`name`,type:`string`,id:`param-name-3`,children:_jsx(_components.p,{children:`Name of the owner entity.`})})]})]}),`\n`,_jsx(ParamField,{body:`domains`,type:`array`,id:`param-domains`,children:_jsx(_components.p,{children:`Fully qualified names of the domains to assign for governance purposes.`})}),`\n`,_jsxs(ParamField,{body:`tags`,type:`array`,id:`param-tags`,children:[_jsx(_components.p,{children:`Array of classification tags to apply to the API endpoint.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`tagFQN`,type:`string`,required:true,id:`param-tag-fqn`,children:_jsx(_components.p,{children:`Fully qualified name of the tag.`})}),_jsx(ParamField,{body:`labelType`,type:`string`,id:`param-label-type`,children:_jsxs(_components.p,{children:[`Type of label, for example `,_jsx(_components.code,{children:`Manual`}),`, `,_jsx(_components.code,{children:`Derived`}),`, `,_jsx(_components.code,{children:`Propagated`}),`.`]})}),_jsx(ParamField,{body:`state`,type:`string`,id:`param-state`,children:_jsxs(_components.p,{children:[`State of the tag, for example `,_jsx(_components.code,{children:`Suggested`}),`, `,_jsx(_components.code,{children:`Confirmed`}),`.`]})})]})]}),`\n`,_jsx(ParamField,{body:`extension`,type:`object`,id:`param-extension`,children:_jsx(_components.p,{children:`Custom property values defined by your organization’s metadata schema.`})}),`\n`,_jsxs(RequestExample,{dropdown:true,children:[_jsx(CodeBlock,{filename:`POST /v1/apiEndpoints`,numberOfLines:`26`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`26`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` metadata.sdk `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` configure`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` metadata.sdk.entities `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` APIEndpoints`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` metadata.generated.schema.api.data.createAPIEndpoint `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` CreateAPIEndpointRequest`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`configure(`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` host`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://your-company.getcollate.io/api\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` jwt_token`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-jwt-token\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`request `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` CreateAPIEndpointRequest(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` name`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"addPet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` displayName`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Add Pet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` apiCollection`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"sample_api_service.pet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` description`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Add a new pet to the store\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` endpointURL`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://petstore3.swagger.io/#/pet/addPet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` requestMethod`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"POST\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` requestSchema`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schemaType\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"JSON\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schemaFields\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"dataType\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"INT\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ID of pet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`endpoint `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` APIEndpoints.create(request)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Created: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`endpoint.fullyQualifiedName.root`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`POST /v1/apiEndpoints`,numberOfLines:`16`,language:`java`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`java`,children:_jsxs(_components.code,{language:`java`,numberOfLines:`16`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` java.net.URI;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` org.openmetadata.schema.api.data.CreateAPIEndpoint;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` org.openmetadata.schema.entity.data.APIEndpoint;`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` org.openmetadata.schema.type.APIRequestMethod;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// client is an initialized OpenMetadataClient.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#4EC9B0`},children:`CreateAPIEndpoint`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` request`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` CreateAPIEndpoint`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` .`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`withName`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"addPet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` .`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`withDisplayName`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Add Pet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` .`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`withApiCollection`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"sample_api_service.pet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` .`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`withDescription`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Add a new pet to the store\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` .`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`withEndpointURL`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`URI`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`create`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://petstore3.swagger.io/#/pet/addPet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`))`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` .`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`withRequestMethod`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`APIRequestMethod`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`POST`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#4EC9B0`},children:`APIEndpoint`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` endpoint`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` client`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`apiEndpoints`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`().`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`create`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(request);`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`POST /v1/apiEndpoints`,numberOfLines:`17`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`17`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"{base_url}/api/v1/apiEndpoints\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer {access_token}\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\": \"addPet\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"displayName\": \"Add Pet\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"apiCollection\": \"sample_api_service.pet\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"description\": \"add a new pet\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"endpointURL\": \"https://petstore3.swagger.io/#/pet/addPet\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"requestMethod\": \"POST\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"requestSchema\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schemaType\": \"JSON\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schemaFields\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` {\"name\": \"id\", \"dataType\": \"INT\", \"description\": \"ID of pet\"}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`Response`,numberOfLines:`30`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`30`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"1f61427a-4a64-4070-9ac8-1d29302dac7c\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"addPet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"displayName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Add Pet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"fullyQualifiedName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"sample_api_service.pet.addPet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"add a new pet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"version\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"updatedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1769982733987`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"updatedBy\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"admin\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"endpointURL\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://petstore3.swagger.io/#/pet/addPet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"requestMethod\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"POST\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"requestSchema\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"schemaType\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"JSON\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"schemaFields\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"dataType\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"INT\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ID of pet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"href\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"http://localhost:8585/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"owners\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tags\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"service\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"58d413a8-abc3-4a6d-bd8a-13a0234b1ff8\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"apiService\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"sample_api_service\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"deleted\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"serviceType\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Rest\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"deleted\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"domains\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: []`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`returns`,children:`Returns`}),`\n`,_jsx(_components.p,{children:`Returns the created API endpoint object with all specified properties and system-generated fields.`}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id-1`,children:_jsx(_components.p,{children:`Unique identifier for the API endpoint (UUID format).`})}),`\n`,_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-4`,children:_jsx(_components.p,{children:`API endpoint name.`})}),`\n`,_jsx(ResponseField,{name:`fullyQualifiedName`,type:`string`,id:`param-fully-qualified-name`,children:_jsxs(_components.p,{children:[`Fully qualified name in format `,_jsx(_components.code,{children:`service.collection.endpointName`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`displayName`,type:`string`,id:`param-display-name-1`,children:_jsx(_components.p,{children:`Human-readable display name.`})}),`\n`,_jsx(ResponseField,{name:`description`,type:`string`,id:`param-description-3`,children:_jsx(_components.p,{children:`Description of the API endpoint in Markdown format.`})}),`\n`,_jsx(ResponseField,{name:`endpointURL`,type:`string`,id:`param-endpoint-url-1`,children:_jsx(_components.p,{children:`URL for the API endpoint.`})}),`\n`,_jsx(ResponseField,{name:`requestMethod`,type:`string`,id:`param-request-method-1`,children:_jsx(_components.p,{children:`HTTP request method (GET, POST, PUT, PATCH, DELETE).`})}),`\n`,_jsxs(ResponseField,{name:`requestSchema`,type:`object`,id:`param-request-schema-1`,children:[_jsx(_components.p,{children:`Schema describing the request body.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`schemaType`,type:`string`,id:`param-schema-type-2`,children:_jsx(_components.p,{children:`Type of schema, for example JSON.`})}),_jsx(ResponseField,{name:`schemaFields`,type:`array`,id:`param-schema-fields-2`,children:_jsx(_components.p,{children:`Array of field definitions.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`responseSchema`,type:`object`,id:`param-response-schema-1`,children:[_jsx(_components.p,{children:`Schema describing the response body.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`schemaType`,type:`string`,id:`param-schema-type-3`,children:_jsx(_components.p,{children:`Type of schema, for example JSON.`})}),_jsx(ResponseField,{name:`schemaFields`,type:`array`,id:`param-schema-fields-3`,children:_jsx(_components.p,{children:`Array of field definitions.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`service`,type:`object`,id:`param-service`,children:[_jsx(_components.p,{children:`Reference to the parent API service.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id-2`,children:_jsx(_components.p,{children:`UUID of the API service.`})}),_jsx(ResponseField,{name:`type`,type:`string`,id:`param-type-1`,children:_jsxs(_components.p,{children:[`Type of entity (always `,_jsx(_components.code,{children:`apiService`}),`).`]})}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-5`,children:_jsx(_components.p,{children:`Name of the API service.`})})]})]}),`\n`,_jsx(ResponseField,{name:`serviceType`,type:`string`,id:`param-service-type`,children:_jsx(_components.p,{children:`Type of API service, for example Rest.`})}),`\n`,_jsxs(ResponseField,{name:`owners`,type:`array`,optional:true,id:`param-owners-1`,children:[_jsx(_components.p,{children:`List of owners assigned to the API endpoint.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id-3`,children:_jsx(_components.p,{children:`UUID of the owner entity.`})}),_jsx(ResponseField,{name:`type`,type:`string`,id:`param-type-2`,children:_jsxs(_components.p,{children:[`Type of owner entity, for example `,_jsx(_components.code,{children:`user`}),`, `,_jsx(_components.code,{children:`team`}),`.`]})}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-6`,children:_jsx(_components.p,{children:`Name of the owner entity.`})})]})]}),`\n`,_jsx(ResponseField,{name:`domains`,type:`array`,optional:true,id:`param-domains-1`,children:_jsx(_components.p,{children:`Domain assignments for governance.`})}),`\n`,_jsxs(ResponseField,{name:`tags`,type:`array`,optional:true,id:`param-tags-1`,children:[_jsx(_components.p,{children:`Classification tags applied to the API endpoint.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`tagFQN`,type:`string`,id:`param-tag-fqn-1`,children:_jsx(_components.p,{children:`Fully qualified name of the tag.`})}),_jsx(ResponseField,{name:`labelType`,type:`string`,id:`param-label-type-1`,children:_jsxs(_components.p,{children:[`Type of label, for example `,_jsx(_components.code,{children:`Manual`}),`, `,_jsx(_components.code,{children:`Derived`}),`, `,_jsx(_components.code,{children:`Propagated`}),`.`]})}),_jsx(ResponseField,{name:`state`,type:`string`,id:`param-state-1`,children:_jsxs(_components.p,{children:[`State of the tag, for example `,_jsx(_components.code,{children:`Suggested`}),`, `,_jsx(_components.code,{children:`Confirmed`}),`.`]})})]})]}),`\n`,_jsx(ResponseField,{name:`extension`,type:`object`,optional:true,id:`param-extension-1`,children:_jsx(_components.p,{children:`Custom property values defined by your organization’s metadata schema.`})}),`\n`,_jsx(ResponseField,{name:`version`,type:`number`,id:`param-version`,children:_jsx(_components.p,{children:`Version number for the entity (starts at 0.1).`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`create-or-update-put`,children:`Create or Update (PUT)`}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`PUT /v1/apiEndpoints`}),` instead of `,_jsx(_components.code,{children:`POST`}),` to perform an upsert. If an API endpoint with the same `,_jsx(_components.code,{children:`fullyQualifiedName`}),` already exists, it will be updated; otherwise, a new API endpoint is created. The request body is the same as `,_jsx(_components.code,{children:`POST`}),`.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` PUT`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"{base_url}/api/v1/apiEndpoints\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer {access_token}\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{ ... same body as POST ... }'`})]}),`\n`]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`PUT`}),` will not return a `,_jsx(_components.code,{children:`409`}),` conflict error if the entity already exists — it will update the existing entity instead. However, for certain fields (such as description, tags, owners, and custom properties), `,_jsx(_components.code,{children:`PUT`}),` preserves an already-populated value instead of overwriting it with an empty or omitted one — the exact behavior depends on the field and the calling user or bot’s permissions, not a blanket rule. See `,_jsx(_components.a,{href:`/api-reference/entity-updates`,children:`Entity Update Behavior`}),` for the full preserve/merge rules. Use `,_jsx(_components.code,{children:`PATCH`}),` to intentionally replace an existing value.`]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`bulk-create-or-update-put`,children:`Bulk Create or Update (PUT)`}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`PUT /v1/apiEndpoints/bulk`}),` to create or update multiple API endpoints in a single request. The request body is an array of create request objects.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` PUT`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"{base_url}/api/v1/apiEndpoints/bulk\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer {access_token}\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '[`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` { \"name\": \"addPet\", \"apiCollection\": \"sample_api_service.pet\", \"requestMethod\": \"POST\" },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` { \"name\": \"getPet\", \"apiCollection\": \"sample_api_service.pet\", \"requestMethod\": \"GET\" }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ]'`})}),`\n`]})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`error-handling`,children:`Error Handling`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Error Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`BAD_REQUEST`})}),_jsx(_components.td,{children:`Invalid request body or missing required fields`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`UNAUTHORIZED`})}),_jsx(_components.td,{children:`Invalid or missing authentication token`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`FORBIDDEN`})}),_jsx(_components.td,{children:`User lacks permission to create API endpoints`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`ENTITY_ALREADY_EXISTS`})}),_jsx(_components.td,{children:`API endpoint with same name already exists in collection (POST only)`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create an API Endpoint","description":"Create a new API endpoint entity with HTTP method, parameters, responses, owners, tags, and metadata within an API collection using the Collate REST API.","sidebarTitle":"Create API Endpoint","api":"POST /v1/apiEndpoints","href":"/api-reference/data-assets/api-endpoints/create"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Create an API Endpoint","slug":"create-an-api-endpoint","depth":1,"children":[]},{"title":"Body Parameters","slug":"body-parameters","depth":2,"children":[]},{"title":"Returns","slug":"returns","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Create or Update (PUT)","slug":"create-or-update-put","depth":2,"children":[]},{"title":"Bulk Create or Update (PUT)","slug":"bulk-create-or-update-put","depth":2,"children":[]},{"title":"Error Handling","slug":"error-handling","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"POST /v1/apiEndpoints","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"python\">\u003ccode language=\"python\" numberOfLines=\"26\">\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\">from\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> metadata.sdk \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\">import\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> configure\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\">from\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> metadata.sdk.entities \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\">import\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> APIEndpoints\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\">from\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> metadata.generated.schema.api.data.createAPIEndpoint \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\">import\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> CreateAPIEndpointRequest\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">configure(\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> host\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://your-company.getcollate.io/api\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> jwt_token\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"your-jwt-token\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">request \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> CreateAPIEndpointRequest(\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> name\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"addPet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> displayName\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Add Pet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> apiCollection\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"sample_api_service.pet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> description\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Add a new pet to the store\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> endpointURL\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://petstore3.swagger.io/#/pet/addPet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> requestMethod\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"POST\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> requestSchema\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"schemaType\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"JSON\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"schemaFields\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"dataType\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"INT\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"description\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"ID of pet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">endpoint \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> APIEndpoints.create(request)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#DCDCAA\">print\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">f\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Created: \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">{\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">endpoint.fullyQualifiedName.root\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">}\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"POST /v1/apiEndpoints","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"java\">\u003ccode language=\"java\" numberOfLines=\"16\">\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">import\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> java.net.URI;\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">import\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> org.openmetadata.schema.api.data.CreateAPIEndpoint;\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">import\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> org.openmetadata.schema.entity.data.APIEndpoint;\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">import\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> org.openmetadata.schema.type.APIRequestMethod;\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#6E7781;--shiki-dark:#6A9955\">// client is an initialized OpenMetadataClient.\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#4EC9B0\">CreateAPIEndpoint\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> request\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\"> =\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\"> new\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\"> CreateAPIEndpoint\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">()\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> .\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">withName\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"addPet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> .\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">withDisplayName\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Add Pet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> .\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">withApiCollection\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"sample_api_service.pet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> .\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">withDescription\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Add a new pet to the store\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> .\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">withEndpointURL\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">URI\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">create\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://petstore3.swagger.io/#/pet/addPet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">))\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> .\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">withRequestMethod\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">APIRequestMethod\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">POST\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">);\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#4EC9B0\">APIEndpoint\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> endpoint\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\"> =\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> client\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">apiEndpoints\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">().\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">create\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(request);\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"POST /v1/apiEndpoints","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"17\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -X\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"{base_url}/api/v1/apiEndpoints\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Authorization: Bearer {access_token}\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Content-Type: application/json\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -d\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"name\": \"addPet\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"displayName\": \"Add Pet\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"apiCollection\": \"sample_api_service.pet\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"description\": \"add a new pet\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"endpointURL\": \"https://petstore3.swagger.io/#/pet/addPet\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"requestMethod\": \"POST\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"requestSchema\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"schemaType\": \"JSON\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"schemaFields\": [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> {\"name\": \"id\", \"dataType\": \"INT\", \"description\": \"ID of pet\"}\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[{"type":"mdxJsxAttribute","name":"dropdown","value":"\"\""}]},"response":{"type":"ResponseExample","children":[{"filename":"Response","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"30\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"1f61427a-4a64-4070-9ac8-1d29302dac7c\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"addPet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"displayName\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Add Pet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"fullyQualifiedName\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"sample_api_service.pet.addPet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"description\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"add a new pet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"version\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">0.1\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"updatedAt\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1769982733987\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"updatedBy\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"admin\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"endpointURL\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://petstore3.swagger.io/#/pet/addPet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"requestMethod\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"POST\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"requestSchema\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"schemaType\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"JSON\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"schemaFields\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"dataType\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"INT\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"description\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"ID of pet\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"href\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"http://localhost:8585/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"owners\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"tags\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"service\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"58d413a8-abc3-4a6d-bd8a-13a0234b1ff8\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"apiService\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"sample_api_service\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"deleted\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">false\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"serviceType\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Rest\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"deleted\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">false\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"domains\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: []\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Create an API Endpoint","path":"/v1/apiEndpoints","servers":[{"url":"https://sandbox.open-metadata.org/api"}],"method":"post","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"name":[{"type":"string","description":"Name of the API endpoint. Must be unique within the parent API collection.","required":true}],"apiCollection":[{"type":"string","description":"Fully qualified name of the parent APICollection, for example `sample_api_service.pet` .","required":true}],"endpointURL":[{"type":"string","description":"URL for the API endpoint, for example `https://petstore3.swagger.io/#/pet/addPet` ."}],"requestMethod":[{"type":"string","description":"HTTP request method: `GET` , `POST` , `PUT` , `PATCH` , or `DELETE` ."}],"requestSchema":[{"type":"object","properties":{"schemaType":[{"type":"string","description":"Type of schema, for example `JSON` ."}],"schemaFields":[{"type":"array","items":[{"type":"object","properties":{"name":[{"type":"string","description":"Name of the field."}],"dataType":[{"type":"string","description":"Data type of the field, for example `INT` , `STRING` , `OBJECT` ."}],"description":[{"type":"string","description":"Description of the field."}]}}],"description":"Array of field objects describing the schema."}]},"description":"Schema describing the request body."}],"responseSchema":[{"type":"object","properties":{"schemaType":[{"type":"string","description":"Type of schema, for example `JSON` ."}],"schemaFields":[{"type":"array","items":[{"type":"object","properties":{"name":[{"type":"string","description":"Name of the field."}],"dataType":[{"type":"string","description":"Data type of the field."}],"description":[{"type":"string","description":"Description of the field."}]}}],"description":"Array of field objects describing the schema."}]},"description":"Schema describing the response body."}],"displayName":[{"type":"string","description":"Human-readable display name for the API endpoint."}],"description":[{"type":"string","description":"Description of the API endpoint in Markdown format."}],"owners":[{"type":"array","items":[{"type":"object","properties":{"id":[{"type":"string","description":"UUID of the owner entity."}],"type":[{"type":"string","description":"Type of owner entity, for example `user` , `team` ."}],"name":[{"type":"string","description":"Name of the owner entity."}]}}],"description":"Array of owner references (users or teams) to assign to the API endpoint."}],"domains":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Fully qualified names of the domains to assign for governance purposes."}],"tags":[{"type":"array","items":[{"type":"object","properties":{"tagFQN":[{"type":"string","description":"Fully qualified name of the tag.","required":true}],"labelType":[{"type":"string","description":"Type of label, for example `Manual` , `Derived` , `Propagated` ."}],"state":[{"type":"string","description":"State of the tag, for example `Suggested` , `Confirmed` ."}]}}],"description":"Array of classification tags to apply to the API endpoint."}],"extension":[{"type":"object","properties":{},"description":"Custom property values defined by your organization’s metadata schema."}]}}],"examples":{"example":{"value":{"name":"\u003cstring>","apiCollection":"\u003cstring>","endpointURL":"\u003cstring>","requestMethod":"\u003cstring>","requestSchema":{"schemaType":"\u003cstring>","schemaFields":[{"name":"\u003cstring>","dataType":"\u003cstring>","description":"\u003cstring>"}]},"responseSchema":{"schemaType":"\u003cstring>","schemaFields":[{"name":"\u003cstring>","dataType":"\u003cstring>","description":"\u003cstring>"}]},"displayName":"\u003cstring>","description":"\u003cstring>","owners":[{"id":"\u003cstring>","type":"\u003cstring>","name":"\u003cstring>"}],"domains":[{}],"tags":[{"tagFQN":"\u003cstring>","labelType":"\u003cstring>","state":"\u003cstring>"}],"extension":{}}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"id":[{"type":"string","description":"Unique identifier for the API endpoint (UUID format)."}],"name":[{"type":"string","description":"API endpoint name."}],"fullyQualifiedName":[{"type":"string","description":"Fully qualified name in format `service.collection.endpointName` ."}],"displayName":[{"type":"string","description":"Human-readable display name."}],"description":[{"type":"string","description":"Description of the API endpoint in Markdown format."}],"endpointURL":[{"type":"string","description":"URL for the API endpoint."}],"requestMethod":[{"type":"string","description":"HTTP request method (GET, POST, PUT, PATCH, DELETE)."}],"requestSchema":[{"type":"object","properties":{"schemaType":[{"type":"string","description":"Type of schema, for example JSON."}],"schemaFields":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Array of field definitions."}]},"description":"Schema describing the request body."}],"responseSchema":[{"type":"object","properties":{"schemaType":[{"type":"string","description":"Type of schema, for example JSON."}],"schemaFields":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Array of field definitions."}]},"description":"Schema describing the response body."}],"service":[{"type":"object","properties":{"id":[{"type":"string","description":"UUID of the API service."}],"type":[{"type":"string","description":"Type of entity (always `apiService` )."}],"name":[{"type":"string","description":"Name of the API service."}]},"description":"Reference to the parent API service."}],"serviceType":[{"type":"string","description":"Type of API service, for example Rest."}],"owners":[{"type":"array","items":[{"type":"object","properties":{"id":[{"type":"string","description":"UUID of the owner entity."}],"type":[{"type":"string","description":"Type of owner entity, for example `user` , `team` ."}],"name":[{"type":"string","description":"Name of the owner entity."}]}}],"description":"List of owners assigned to the API endpoint."}],"domains":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Domain assignments for governance."}],"tags":[{"type":"array","items":[{"type":"object","properties":{"tagFQN":[{"type":"string","description":"Fully qualified name of the tag."}],"labelType":[{"type":"string","description":"Type of label, for example `Manual` , `Derived` , `Propagated` ."}],"state":[{"type":"string","description":"State of the tag, for example `Suggested` , `Confirmed` ."}]}}],"description":"Classification tags applied to the API endpoint."}],"extension":[{"type":"object","properties":{},"description":"Custom property values defined by your organization’s metadata schema."}],"version":[{"type":"number","description":"Version number for the entity (starts at 0.1)."}]}}],"examples":{"example":{"value":{"id":"\u003cstring>","name":"\u003cstring>","fullyQualifiedName":"\u003cstring>","displayName":"\u003cstring>","description":"\u003cstring>","endpointURL":"\u003cstring>","requestMethod":"\u003cstring>","requestSchema":{"schemaType":"\u003cstring>","schemaFields":[{}]},"responseSchema":{"schemaType":"\u003cstring>","schemaFields":[{}]},"service":{"id":"\u003cstring>","type":"\u003cstring>","name":"\u003cstring>"},"serviceType":"\u003cstring>","owners":[{"id":"\u003cstring>","type":"\u003cstring>","name":"\u003cstring>"}],"domains":[{}],"tags":[{"tagFQN":"\u003cstring>","labelType":"\u003cstring>","state":"\u003cstring>"}],"extension":{},"version":123}}}}}},"deprecated":false}},"jsLinks":["/_mintlify/custom/collatedocs/193c43da98baa789/loader.js"],"subdomain":"collatedocs","siteName":"Collate Documentation","title":"Create an API Endpoint - Collate Documentation","navMaps":{"firstHrefInVersion":{"AI 2.0":{"href":"/","matchLevel":4},"Classic":{"href":"/api-reference/data-assets/api-endpoints/create","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T06:34:43.784Z","originalFileLocation":"api-reference/data-assets/api-endpoints/create.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a new API endpoint entity with HTTP method, parameters, responses, owners, tags, and metadata within an API collection using the Collate REST API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Collate Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index,follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/collatedocs/Wy3ST-458y16Xhek/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/collatedocs/Wy3ST-458y16Xhek/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/collatedocs/Wy3ST-458y16Xhek/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/collatedocs/Wy3ST-458y16Xhek/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/collatedocs/Wy3ST-458y16Xhek/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/collatedocs/Wy3ST-458y16Xhek/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/collatedocs/Wy3ST-458y16Xhek/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/collatedocs/Wy3ST-458y16Xhek/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/collatedocs/Wy3ST-458y16Xhek/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an API Endpoint - Collate Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new API endpoint entity with HTTP method, parameters, responses, owners, tags, and metadata within an API collection using the Collate REST API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Collate Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getcollate.io/api-reference/data-assets/api-endpoints/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://collatedocs.mintlify.site/_mintlify/api/og/v2?division=API+Endpoints\u0026amp;title=Create+an+API+Endpoint\u0026amp;description=Create+a+new+API+endpoint+entity+with+HTTP+method%2C+parameters%2C+responses%2C+owners%2C+tags%2C+and+metadata+within+an+API+collection+using+the+Collate+REST+API.\u0026amp;theme=1b066d8b17e8e32af494b9f2\u0026amp;signature=1422af8e2087959aa38bacde5a846549afa695d8a105ebff95c453fcf055f062\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create an API Endpoint - Collate Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new API endpoint entity with HTTP method, parameters, responses, owners, tags, and metadata within an API collection using the Collate REST API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://collatedocs.mintlify.site/_mintlify/api/og/v2?division=API+Endpoints\u0026amp;title=Create+an+API+Endpoint\u0026amp;description=Create+a+new+API+endpoint+entity+with+HTTP+method%2C+parameters%2C+responses%2C+owners%2C+tags%2C+and+metadata+within+an+API+collection+using+the+Collate+REST+API.\u0026amp;theme=1b066d8b17e8e32af494b9f2\u0026amp;signature=1422af8e2087959aa38bacde5a846549afa695d8a105ebff95c453fcf055f062\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/collatedocs/Wy3ST-458y16Xhek/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Collate Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1570EF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getcollate.io/api-reference/data-assets/api-endpoints/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/data-assets/api-endpoints/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getcollate.io/#organization\",\"name\":\"Collate Documentation\",\"url\":\"https://docs.getcollate.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/collatedocs/yvgGxaeRR5RwtQo6/public/images/icons/collate-logo.svg?fit=max\u0026auto=format\u0026n=yvgGxaeRR5RwtQo6\u0026q=85\u0026s=59d7983952a91cd53138369f2e21a5ac\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getcollate.io#website\",\"name\":\"Collate Documentation\",\"url\":\"https://docs.getcollate.io\",\"publisher\":{\"@id\":\"https://docs.getcollate.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getcollate.io/api-reference/data-assets/api-endpoints/create#webpage\",\"url\":\"https://docs.getcollate.io/api-reference/data-assets/api-endpoints/create\",\"name\":\"Create an API Endpoint\",\"description\":\"Create a new API endpoint entity with HTTP method, parameters, responses, owners, tags, and metadata within an API collection using the Collate REST API.\",\"dateModified\":\"2026-10-29T06:34:43.784Z\",\"isPartOf\":{\"@id\":\"https://docs.getcollate.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getcollate.io/api-reference/data-assets/api-endpoints/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getcollate.io/api-reference/data-assets/api-endpoints/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"SDKs and APIs\",\"item\":\"https://docs.getcollate.io/sdk\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Collate APIs\",\"item\":\"https://docs.getcollate.io/api-reference/api-overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Data Assets\",\"item\":\"https://docs.getcollate.io/api-reference/data-assets\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"API Services\",\"item\":\"https://docs.getcollate.io/api-reference/data-assets/api-collections\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"API Endpoints\",\"item\":\"https://docs.getcollate.io/api-reference/data-assets/api-endpoints\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"Create an API Endpoint\",\"item\":\"https://docs.getcollate.io/api-reference/data-assets/api-endpoints/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getcollate.io/api-reference/data-assets/api-endpoints/create#apireference\",\"headline\":\"Create an API Endpoint\",\"name\":\"Create an API Endpoint\",\"description\":\"Create a new API endpoint entity with HTTP method, parameters, responses, owners, tags, and metadata within an API collection using the Collate REST API.\",\"url\":\"https://docs.getcollate.io/api-reference/data-assets/api-endpoints/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getcollate.io/api-reference/data-assets/api-endpoints/create#webpage\"},\"dateModified\":\"2026-10-29T06:34:43.784Z\",\"publisher\":{\"@id\":\"https://docs.getcollate.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getcollate.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Collate Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Collate Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/data-assets/api-endpoints/create.md","siteName":"Collate Documentation","nav":{"global":null,"versions":[{"version":"AI 2.0","default":true,"pages":[{"title":"AI 2.0","href":"/"}]},{"version":"Classic","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/classic"}]},{"tab":"Release 2.0","pages":[{"title":"Release 2.0","href":"/release-2.0"}]},{"tab":"Get started","pages":[{"title":"Get started","href":"/getting-started"}]},{"tab":"Connectors","pages":[{"title":"Connectors","href":"/connectors"}]},{"tab":"Products","pages":[{"title":"Products","href":"/products"}]},{"tab":"Collate AI","pages":[{"title":"Collate AI","href":"/collate-ai"}]},{"tab":"How-To Guides","pages":[{"title":"How-To Guides","href":"/how-to-guides"}]},{"tab":"Admin Guide","pages":[{"title":"Admin Guide","href":"/how-to-guides/admin-guide"}]},{"tab":"Customer Support","pages":[{"title":"Customer Support","href":"/how-to-guides/collate-customer-support"}]},{"tab":"Guide for Data Users","pages":[{"title":"Guide for Data Users","href":"/how-to-guides/guide-for-data-users"}]},{"tab":"SSO","pages":[{"title":"SSO","href":"/how-to-guides/sso"}]},{"tab":"Data Contracts","pages":[{"title":"Data Contracts","href":"/how-to-guides/data-contracts"}]},{"tab":"Data Discovery","pages":[{"title":"Data Discovery","href":"/how-to-guides/data-discovery"}]},{"tab":"Data Collaboration","pages":[{"title":"Data Collaboration","href":"/how-to-guides/data-collaboration"}]},{"tab":"Data Quality \u0026 Observability","pages":[{"title":"Data Quality \u0026 Observability","href":"/how-to-guides/data-quality-observability"}]},{"tab":"Data Lineage","pages":[{"title":"Data Lineage","href":"/how-to-guides/data-lineage"}]},{"tab":"Data Insights","pages":[{"title":"Data Insights","href":"/how-to-guides/data-insights"}]},{"tab":"Data Governance","pages":[{"title":"Data Governance","href":"/how-to-guides/data-governance"}]},{"tab":"SQL Studio","pages":[{"title":"SQL Studio","href":"/how-to-guides/sql-studio"}]},{"tab":"Deployment","pages":[{"title":"Deployment","href":"/how-to-guides/deployment/hybrid-runner"}]},{"tab":"SDKs \u0026 APIs","groups":[{"group":"SDKs and APIs","pages":[{"title":"Collate SDK | Collate Software Development Kit","sidebarTitle":"SDKs and APIs","href":"/sdk"},{"title":"Collate SDKs \u0026 APIs","sidebarTitle":"Introduction","href":"/api-reference/index"},{"title":"Getting Started","sidebarTitle":"Getting Started","href":"/api-reference/getting-started"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","sidebarTitle":"Errors","mode":"wide","href":"/api-reference/errors"},{"title":"Pagination","sidebarTitle":"Pagination","mode":"wide","href":"/api-reference/pagination"},{"title":"Entity Update Behavior (PUT vs PATCH)","sidebarTitle":"Entity Updates","href":"/api-reference/entity-updates"},{"title":"Conversation V2","sidebarTitle":"Conversations","href":"/api-reference/conversations"},{"group":"Collate SDKs","pages":[{"title":"Collate SDKs","sidebarTitle":"SDK Overview","href":"/sdk/overview"},{"group":"AI SDK","pages":[{"title":"AI SDK","sidebarTitle":"AI SDK","href":"/sdk/ai-sdk"}]},{"group":"Python SDK","pages":[{"title":"Collate Python SDK quickstart","sidebarTitle":"Python SDK","href":"/sdk/python/index"},{"title":"Python SDK Ingestion","sidebarTitle":"Python SDK Ingestion","href":"/sdk/python/ingestion/index"},{"title":"Python SDK for Lineage","sidebarTitle":"Lineage","href":"/sdk/python/ingestion/lineage"},{"title":"Python SDK for Tags","sidebarTitle":"Tags","href":"/sdk/python/ingestion/tags"},{"group":"Collate Python SDK","pages":[{"title":"Python Fluent API | Collate","sidebarTitle":"Collate Python SDK","href":"/sdk/python/fluent/index"},{"title":"Dashboards | Python Fluent API | Collate","sidebarTitle":"Dashboards","href":"/sdk/python/fluent/dashboards"},{"title":"Database Schemas | Python Fluent API | Collate","sidebarTitle":"Database Schemas","href":"/sdk/python/fluent/database-schemas"},{"title":"Database Services | Python Fluent API | Collate","sidebarTitle":"Database Services","href":"/sdk/python/fluent/database-services"},{"title":"Databases | Python Fluent API | Collate","sidebarTitle":"Databases","href":"/sdk/python/fluent/databases"},{"title":"Pipelines | Python Fluent API | Collate","sidebarTitle":"Pipelines","href":"/sdk/python/fluent/pipelines"},{"title":"Tables | Python Fluent API | Collate","sidebarTitle":"Tables","href":"/sdk/python/fluent/tables"},{"title":"Users | Python Fluent API | Collate","sidebarTitle":"Users","href":"/sdk/python/fluent/users"}]}]},{"group":"Java SDK","pages":[{"title":"Java SDK | Collate Java SDK Documentation","sidebarTitle":"Java SDK","href":"/sdk/java/index"},{"title":"Java SDK Overview","sidebarTitle":"Collate Java SDK","href":"/sdk/java/info"},{"title":"Java SDK for Lineage | Collate Docs","sidebarTitle":"Lineage","href":"/sdk/java/lineage"},{"title":"Java SDK for Glossary Relations | Collate Docs","sidebarTitle":"Glossary Relations","href":"/sdk/java/glossary-relations"}]},{"group":"Go SDK","pages":[{"title":"Go SDK","sidebarTitle":"Go SDK","href":"/sdk/go/index"}]}]},{"group":"Collate APIs","pages":[{"title":"Collate API Overview","sidebarTitle":"API Overview","href":"/api-reference/api-overview"},{"group":"Data Assets","pages":[{"title":"Data Assets","sidebarTitle":"Overview","href":"/api-reference/data-assets/index"},{"group":"Databases","pages":[{"title":"Databases","sidebarTitle":"Database Hierarchy","href":"/api-reference/data-assets/databases-overview"},{"title":"Services Overview","sidebarTitle":"Services Overview","api":"GET /v1/services/overview","href":"/api-reference/data-assets/services-overview"},{"title":"Entity Columns and Fields","sidebarTitle":"Columns and Fields","href":"/api-reference/data-assets/columns"},{"group":"Database Services","pages":[{"title":"Database Services","sidebarTitle":"Database Services","href":"/api-reference/data-assets/database-services/index"},{"title":"List Database Services","sidebarTitle":"List Database Services","api":"GET /v1/services/databaseServices","href":"/api-reference/data-assets/database-services/list"},{"title":"Create a Database Service","sidebarTitle":"Create Database Service","api":"POST /v1/services/databaseServices","href":"/api-reference/data-assets/database-services/create"},{"title":"Retrieve a Database Service","sidebarTitle":"Retrieve Database Service","api":"GET /v1/services/databaseServices/{id}","href":"/api-reference/data-assets/database-services/retrieve"},{"title":"Update a Database Service","sidebarTitle":"Update Database Service","api":"PUT /v1/services/databaseServices","href":"/api-reference/data-assets/database-services/update"},{"title":"Delete a Database Service","sidebarTitle":"Delete Database Service","api":"DELETE /v1/services/databaseServices/{id}","href":"/api-reference/data-assets/database-services/delete"},{"title":"Database Service Versions","sidebarTitle":"Versions","api":"GET /v1/services/databaseServices/{id}/versions","href":"/api-reference/data-assets/database-services/versions"},{"title":"Import \u0026 Export Database Services","sidebarTitle":"Import / Export","api":"GET /v1/services/databaseServices/name/{fqn}/export","href":"/api-reference/data-assets/database-services/import-export"}]},{"group":"Databases","pages":[{"title":"Databases","sidebarTitle":"Databases","href":"/api-reference/data-assets/databases/index"},{"title":"List Databases","sidebarTitle":"List Databases","api":"GET /v1/databases","href":"/api-reference/data-assets/databases/list"},{"title":"Create a Database","sidebarTitle":"Create Database","api":"POST /v1/databases","href":"/api-reference/data-assets/databases/create"},{"title":"Retrieve a Database","sidebarTitle":"Retrieve Database","api":"GET /v1/databases/{id}","href":"/api-reference/data-assets/databases/retrieve"},{"title":"Update a Database","sidebarTitle":"Update Database","api":"PUT /v1/databases","href":"/api-reference/data-assets/databases/update"},{"title":"Delete a Database","sidebarTitle":"Delete Database","api":"DELETE /v1/databases/{id}","href":"/api-reference/data-assets/databases/delete"},{"title":"Database Versions","sidebarTitle":"Versions","api":"GET /v1/databases/{id}/versions","href":"/api-reference/data-assets/databases/versions"},{"title":"Import \u0026 Export Databases","sidebarTitle":"Import / Export","api":"GET /v1/databases/name/{fqn}/export","href":"/api-reference/data-assets/databases/import-export"},{"title":"Advanced Database Operations","sidebarTitle":"Advanced","api":"PUT /v1/databases/{id}/followers","href":"/api-reference/data-assets/databases/advanced"}]},{"group":"Database Schemas","pages":[{"title":"Database Schemas","sidebarTitle":"Database Schemas","href":"/api-reference/data-assets/database-schemas/index"},{"title":"List Database Schemas","sidebarTitle":"List Schemas","api":"GET /v1/databaseSchemas","href":"/api-reference/data-assets/database-schemas/list"},{"title":"Create a Database Schema","sidebarTitle":"Create Schema","api":"POST /v1/databaseSchemas","href":"/api-reference/data-assets/database-schemas/create"},{"title":"Retrieve a Database Schema","sidebarTitle":"Retrieve Schema","api":"GET /v1/databaseSchemas/{id}","href":"/api-reference/data-assets/database-schemas/retrieve"},{"title":"Update a Database Schema","sidebarTitle":"Update Schema","api":"PUT /v1/databaseSchemas","href":"/api-reference/data-assets/database-schemas/update"},{"title":"Delete a Database Schema","sidebarTitle":"Delete Schema","api":"DELETE /v1/databaseSchemas/{id}","href":"/api-reference/data-assets/database-schemas/delete"},{"title":"Database Schema Versions","sidebarTitle":"Versions","api":"GET /v1/databaseSchemas/{id}/versions","href":"/api-reference/data-assets/database-schemas/versions"},{"title":"Import \u0026 Export Database Schemas","sidebarTitle":"Import / Export","api":"GET /v1/databaseSchemas/name/{fqn}/export","href":"/api-reference/data-assets/database-schemas/import-export"},{"title":"Advanced Database Schema Operations","sidebarTitle":"Advanced","api":"PUT /v1/databaseSchemas/{id}/followers","href":"/api-reference/data-assets/database-schemas/advanced"}]},{"group":"Tables","pages":[{"title":"Tables","sidebarTitle":"Tables","href":"/api-reference/data-assets/tables/index"},{"title":"List Tables","sidebarTitle":"List Tables","api":"GET /v1/tables","href":"/api-reference/data-assets/tables/list"},{"title":"Create a table","sidebarTitle":"Create Table","api":"POST /v1/tables","href":"/api-reference/data-assets/tables/create"},{"title":"Retrieve a Table","sidebarTitle":"Retrieve Table","api":"GET /v1/tables/{id}","href":"/api-reference/data-assets/tables/retrieve"},{"title":"Update a Table","sidebarTitle":"Update Table","api":"PUT /v1/tables","href":"/api-reference/data-assets/tables/update"},{"title":"Delete a Table","sidebarTitle":"Delete Table","api":"DELETE /v1/tables/{id}","href":"/api-reference/data-assets/tables/delete"},{"title":"Table Versions","sidebarTitle":"Versions","api":"GET /v1/tables/{id}/versions","href":"/api-reference/data-assets/tables/versions"},{"title":"Import \u0026 Export Tables","sidebarTitle":"Import / Export","api":"GET /v1/tables/name/{fqn}/export","href":"/api-reference/data-assets/tables/import-export"},{"title":"Table Sample Data","sidebarTitle":"Sample Data","api":"GET /v1/tables/{id}/sampleData","href":"/api-reference/data-assets/tables/sample-data"},{"title":"Table Profiler","sidebarTitle":"Profiler","api":"GET /v1/tables/{id}/tableProfilerConfig","href":"/api-reference/data-assets/tables/profiler"},{"title":"Pipeline Observability","sidebarTitle":"Observability","api":"GET /v1/tables/{id}/pipelineObservability","href":"/api-reference/data-assets/tables/observability"},{"title":"Table Relationships","sidebarTitle":"Relationships","api":"PUT /v1/tables/{id}/joins","href":"/api-reference/data-assets/tables/relationships"},{"title":"Custom Metrics","sidebarTitle":"Custom Metrics","api":"PUT /v1/tables/{id}/customMetric","href":"/api-reference/data-assets/tables/custom-metrics"},{"title":"Followers \u0026 Votes","sidebarTitle":"Followers \u0026 Votes","api":"PUT /v1/tables/{id}/followers","href":"/api-reference/data-assets/tables/followers-votes"}]},{"group":"Stored Procedures","pages":[{"title":"Stored Procedures","sidebarTitle":"Stored Procedures","href":"/api-reference/data-assets/stored-procedures/index"},{"title":"List Stored Procedures","sidebarTitle":"List Stored Procedures","api":"GET /v1/storedProcedures","href":"/api-reference/data-assets/stored-procedures/list"},{"title":"Create a Stored Procedure","sidebarTitle":"Create Stored Procedure","api":"POST /v1/storedProcedures","href":"/api-reference/data-assets/stored-procedures/create"},{"title":"Retrieve a Stored Procedure","sidebarTitle":"Retrieve Stored Procedure","api":"GET /v1/storedProcedures/{id}","href":"/api-reference/data-assets/stored-procedures/retrieve"},{"title":"Update a Stored Procedure","sidebarTitle":"Update Stored Procedure","api":"PUT /v1/storedProcedures","href":"/api-reference/data-assets/stored-procedures/update"},{"title":"Delete a Stored Procedure","sidebarTitle":"Delete Stored Procedure","api":"DELETE /v1/storedProcedures/{id}","href":"/api-reference/data-assets/stored-procedures/delete"},{"title":"Stored Procedure Versions","sidebarTitle":"Versions","api":"GET /v1/storedProcedures/{id}/versions","href":"/api-reference/data-assets/stored-procedures/versions"},{"title":"Followers \u0026 Votes","sidebarTitle":"Followers \u0026 Votes","api":"PUT /v1/storedProcedures/{id}/followers","href":"/api-reference/data-assets/stored-procedures/followers-votes"}]}]},{"group":"Messaging","pages":[{"group":"Messaging Services","pages":[{"title":"Messaging Services","sidebarTitle":"Messaging Services","href":"/api-reference/data-assets/messaging-services/index"},{"title":"List Messaging Services","sidebarTitle":"List Messaging Services","api":"GET /v1/services/messagingServices","href":"/api-reference/data-assets/messaging-services/list"},{"title":"Create a Messaging Service","sidebarTitle":"Create Messaging Service","api":"POST /v1/services/messagingServices","href":"/api-reference/data-assets/messaging-services/create"},{"title":"Retrieve a Messaging Service","sidebarTitle":"Retrieve Messaging Service","api":"GET /v1/services/messagingServices/{id}","href":"/api-reference/data-assets/messaging-services/retrieve"},{"title":"Update a Messaging Service","sidebarTitle":"Update Messaging Service","api":"PUT /v1/services/messagingServices","href":"/api-reference/data-assets/messaging-services/update"},{"title":"Delete a Messaging Service","sidebarTitle":"Delete Messaging Service","api":"DELETE /v1/services/messagingServices/{id}","href":"/api-reference/data-assets/messaging-services/delete"},{"title":"Messaging Service Versions","sidebarTitle":"Versions","api":"GET /v1/services/messagingServices/{id}/versions","href":"/api-reference/data-assets/messaging-services/versions"},{"title":"Import \u0026 Export Messaging Services","sidebarTitle":"Import / Export","api":"GET /v1/services/messagingServices/name/{fqn}/export","href":"/api-reference/data-assets/messaging-services/import-export"}]},{"group":"Topics","pages":[{"title":"Topics","sidebarTitle":"Topics","href":"/api-reference/data-assets/topics/index"},{"title":"List Topics","sidebarTitle":"List Topics","api":"GET /v1/topics","href":"/api-reference/data-assets/topics/list"},{"title":"Create a Topic","sidebarTitle":"Create Topic","api":"POST /v1/topics","href":"/api-reference/data-assets/topics/create"},{"title":"Retrieve a Topic","sidebarTitle":"Retrieve Topic","api":"GET /v1/topics/{id}","href":"/api-reference/data-assets/topics/retrieve"},{"title":"Update a Topic","sidebarTitle":"Update Topic","api":"PUT /v1/topics","href":"/api-reference/data-assets/topics/update"},{"title":"Delete a Topic","sidebarTitle":"Delete Topic","api":"DELETE /v1/topics/{id}","href":"/api-reference/data-assets/topics/delete"},{"title":"Topic Versions","sidebarTitle":"Versions","api":"GET /v1/topics/{id}/versions","href":"/api-reference/data-assets/topics/versions"},{"title":"Followers \u0026 Votes","sidebarTitle":"Followers \u0026 Votes","api":"PUT /v1/topics/{id}/followers","href":"/api-reference/data-assets/topics/followers-votes"}]}]},{"group":"Dashboards","pages":[{"group":"Dashboard Services","pages":[{"title":"Dashboard Services","sidebarTitle":"Dashboard Services","href":"/api-reference/data-assets/dashboard-services/index"},{"title":"List Dashboard Services","sidebarTitle":"List Dashboard Services","api":"GET /v1/services/dashboardServices","href":"/api-reference/data-assets/dashboard-services/list"},{"title":"Create a Dashboard Service","sidebarTitle":"Create Dashboard Service","api":"POST /v1/services/dashboardServices","href":"/api-reference/data-assets/dashboard-services/create"},{"title":"Retrieve a Dashboard Service","sidebarTitle":"Retrieve Dashboard Service","api":"GET /v1/services/dashboardServices/{id}","href":"/api-reference/data-assets/dashboard-services/retrieve"},{"title":"Update a Dashboard Service","sidebarTitle":"Update Dashboard Service","api":"PUT /v1/services/dashboardServices","href":"/api-reference/data-assets/dashboard-services/update"},{"title":"Delete a Dashboard Service","sidebarTitle":"Delete Dashboard Service","api":"DELETE /v1/services/dashboardServices/{id}","href":"/api-reference/data-assets/dashboard-services/delete"},{"title":"Dashboard Service Versions","sidebarTitle":"Versions","api":"GET /v1/services/dashboardServices/{id}/versions","href":"/api-reference/data-assets/dashboard-services/versions"},{"title":"Import \u0026 Export Dashboard Services","sidebarTitle":"Import / Export","api":"GET /v1/services/dashboardServices/name/{fqn}/export","href":"/api-reference/data-assets/dashboard-services/import-export"}]},{"group":"Dashboards","pages":[{"title":"Dashboards","sidebarTitle":"Dashboards","href":"/api-reference/data-assets/dashboards/index"},{"title":"List Dashboards","sidebarTitle":"List Dashboards","api":"GET /v1/dashboards","href":"/api-reference/data-assets/dashboards/list"},{"title":"Create a Dashboard","sidebarTitle":"Create Dashboard","api":"POST /v1/dashboards","href":"/api-reference/data-assets/dashboards/create"},{"title":"Retrieve a Dashboard","sidebarTitle":"Retrieve Dashboard","api":"GET /v1/dashboards/{id}","href":"/api-reference/data-assets/dashboards/retrieve"},{"title":"Update a Dashboard","sidebarTitle":"Update Dashboard","api":"PUT /v1/dashboards","href":"/api-reference/data-assets/dashboards/update"},{"title":"Delete a Dashboard","sidebarTitle":"Delete Dashboard","api":"DELETE /v1/dashboards/{id}","href":"/api-reference/data-assets/dashboards/delete"},{"title":"Dashboard Versions","sidebarTitle":"Versions","api":"GET /v1/dashboards/{id}/versions","href":"/api-reference/data-assets/dashboards/versions"},{"title":"Followers \u0026 Votes","sidebarTitle":"Followers \u0026 Votes","api":"PUT /v1/dashboards/{id}/followers","href":"/api-reference/data-assets/dashboards/followers-votes"}]},{"group":"Charts","pages":[{"title":"Charts","sidebarTitle":"Charts","href":"/api-reference/data-assets/charts/index"},{"title":"List Charts","sidebarTitle":"List Charts","api":"GET /v1/charts","href":"/api-reference/data-assets/charts/list"},{"title":"Create a Chart","sidebarTitle":"Create Chart","api":"POST /v1/charts","href":"/api-reference/data-assets/charts/create"},{"title":"Retrieve a Chart","sidebarTitle":"Retrieve Chart","api":"GET /v1/charts/{id}","href":"/api-reference/data-assets/charts/retrieve"},{"title":"Update a Chart","sidebarTitle":"Update Chart","api":"PUT /v1/charts","href":"/api-reference/data-assets/charts/update"},{"title":"Delete a Chart","sidebarTitle":"Delete Chart","api":"DELETE /v1/charts/{id}","href":"/api-reference/data-assets/charts/delete"},{"title":"Chart Versions","sidebarTitle":"Versions","api":"GET /v1/charts/{id}/versions","href":"/api-reference/data-assets/charts/versions"}]}]},{"group":"Pipelines","pages":[{"group":"Pipeline Services","pages":[{"title":"Pipeline Services","sidebarTitle":"Pipeline Services","href":"/api-reference/data-assets/pipeline-services/index"},{"title":"List Pipeline Services","sidebarTitle":"List Pipeline Services","api":"GET /v1/services/pipelineServices","href":"/api-reference/data-assets/pipeline-services/list"},{"title":"Create a Pipeline Service","sidebarTitle":"Create Pipeline Service","api":"POST /v1/services/pipelineServices","href":"/api-reference/data-assets/pipeline-services/create"},{"title":"Retrieve a Pipeline Service","sidebarTitle":"Retrieve Pipeline Service","api":"GET /v1/services/pipelineServices/{id}","href":"/api-reference/data-assets/pipeline-services/retrieve"},{"title":"Update a Pipeline Service","sidebarTitle":"Update Pipeline Service","api":"PUT /v1/services/pipelineServices","href":"/api-reference/data-assets/pipeline-services/update"},{"title":"Delete a Pipeline Service","sidebarTitle":"Delete Pipeline Service","api":"DELETE /v1/services/pipelineServices/{id}","href":"/api-reference/data-assets/pipeline-services/delete"},{"title":"Pipeline Service Versions","sidebarTitle":"Versions","api":"GET /v1/services/pipelineServices/{id}/versions","href":"/api-reference/data-assets/pipeline-services/versions"},{"title":"Import \u0026 Export Pipeline Services","sidebarTitle":"Import / Export","api":"GET /v1/services/pipelineServices/name/{fqn}/export","href":"/api-reference/data-assets/pipeline-services/import-export"}]},{"group":"Pipelines","pages":[{"title":"Pipelines","sidebarTitle":"Pipelines","href":"/api-reference/data-assets/pipelines/index"},{"title":"List Pipelines","sidebarTitle":"List Pipelines","api":"GET /v1/pipelines","href":"/api-reference/data-assets/pipelines/list"},{"title":"Create a Pipeline","sidebarTitle":"Create Pipeline","api":"POST /v1/pipelines","href":"/api-reference/data-assets/pipelines/create"},{"title":"Retrieve a Pipeline","sidebarTitle":"Retrieve Pipeline","api":"GET /v1/pipelines/{id}","href":"/api-reference/data-assets/pipelines/retrieve"},{"title":"Update a Pipeline","sidebarTitle":"Update Pipeline","api":"PUT /v1/pipelines","href":"/api-reference/data-assets/pipelines/update"},{"title":"Delete a Pipeline","sidebarTitle":"Delete Pipeline","api":"DELETE /v1/pipelines/{id}","href":"/api-reference/data-assets/pipelines/delete"},{"title":"Pipeline Versions","sidebarTitle":"Versions","api":"GET /v1/pipelines/{id}/versions","href":"/api-reference/data-assets/pipelines/versions"},{"title":"Followers \u0026 Votes","sidebarTitle":"Followers \u0026 Votes","api":"PUT /v1/pipelines/{id}/followers","href":"/api-reference/data-assets/pipelines/followers-votes"}]}]},{"group":"ML Models","pages":[{"group":"ML Model Services","pages":[{"title":"ML Model Services","sidebarTitle":"ML Model Services","href":"/api-reference/data-assets/mlmodel-services/index"},{"title":"List ML Model Services","sidebarTitle":"List ML Model Services","api":"GET /v1/services/mlmodelServices","href":"/api-reference/data-assets/mlmodel-services/list"},{"title":"Create an ML Model Service","sidebarTitle":"Create ML Model Service","api":"POST /v1/services/mlmodelServices","href":"/api-reference/data-assets/mlmodel-services/create"},{"title":"Retrieve an ML Model Service","sidebarTitle":"Retrieve ML Model Service","api":"GET /v1/services/mlmodelServices/{id}","href":"/api-reference/data-assets/mlmodel-services/retrieve"},{"title":"Update an ML Model Service","sidebarTitle":"Update ML Model Service","api":"PUT /v1/services/mlmodelServices","href":"/api-reference/data-assets/mlmodel-services/update"},{"title":"Delete an ML Model Service","sidebarTitle":"Delete ML Model Service","api":"DELETE /v1/services/mlmodelServices/{id}","href":"/api-reference/data-assets/mlmodel-services/delete"},{"title":"ML Model Service Versions","sidebarTitle":"Versions","api":"GET /v1/services/mlmodelServices/{id}/versions","href":"/api-reference/data-assets/mlmodel-services/versions"}]},{"group":"ML Models","pages":[{"title":"ML Models","sidebarTitle":"ML Models","href":"/api-reference/data-assets/mlmodels/index"},{"title":"List ML Models","sidebarTitle":"List ML Models","api":"GET /v1/mlmodels","href":"/api-reference/data-assets/mlmodels/list"},{"title":"Create an ML Model","sidebarTitle":"Create ML Model","api":"POST /v1/mlmodels","href":"/api-reference/data-assets/mlmodels/create"},{"title":"Retrieve an ML Model","sidebarTitle":"Retrieve ML Model","api":"GET /v1/mlmodels/{id}","href":"/api-reference/data-assets/mlmodels/retrieve"},{"title":"Update an ML Model","sidebarTitle":"Update ML Model","api":"PUT /v1/mlmodels","href":"/api-reference/data-assets/mlmodels/update"},{"title":"Delete an ML Model","sidebarTitle":"Delete ML Model","api":"DELETE /v1/mlmodels/{id}","href":"/api-reference/data-assets/mlmodels/delete"},{"title":"ML Model Versions","sidebarTitle":"Versions","api":"GET /v1/mlmodels/{id}/versions","href":"/api-reference/data-assets/mlmodels/versions"},{"title":"Followers \u0026 Votes","sidebarTitle":"Followers \u0026 Votes","api":"PUT /v1/mlmodels/{id}/followers","href":"/api-reference/data-assets/mlmodels/followers-votes"}]}]},{"group":"Storage","pages":[{"group":"Storage Services","pages":[{"title":"Storage Services","sidebarTitle":"Storage Services","href":"/api-reference/data-assets/storage-services/index"},{"title":"List Storage Services","sidebarTitle":"List Storage Services","api":"GET /v1/services/storageServices","href":"/api-reference/data-assets/storage-services/list"},{"title":"Create a Storage Service","sidebarTitle":"Create Storage Service","api":"POST /v1/services/storageServices","href":"/api-reference/data-assets/storage-services/create"},{"title":"Retrieve a Storage Service","sidebarTitle":"Retrieve Storage Service","api":"GET /v1/services/storageServices/{id}","href":"/api-reference/data-assets/storage-services/retrieve"},{"title":"Update a Storage Service","sidebarTitle":"Update Storage Service","api":"PUT /v1/services/storageServices","href":"/api-reference/data-assets/storage-services/update"},{"title":"Delete a Storage Service","sidebarTitle":"Delete Storage Service","api":"DELETE /v1/services/storageServices/{id}","href":"/api-reference/data-assets/storage-services/delete"},{"title":"Storage Service Versions","sidebarTitle":"Versions","api":"GET /v1/services/storageServices/{id}/versions","href":"/api-reference/data-assets/storage-services/versions"}]},{"group":"Containers","pages":[{"title":"Containers","sidebarTitle":"Containers","href":"/api-reference/data-assets/containers/index"},{"title":"List Containers","sidebarTitle":"List Containers","api":"GET /v1/containers","href":"/api-reference/data-assets/containers/list"},{"title":"Create a Container","sidebarTitle":"Create Container","api":"POST /v1/containers","href":"/api-reference/data-assets/containers/create"},{"title":"Retrieve a Container","sidebarTitle":"Retrieve Container","api":"GET /v1/containers/{id}","href":"/api-reference/data-assets/containers/retrieve"},{"title":"Update a Container","sidebarTitle":"Update Container","api":"PUT /v1/containers","href":"/api-reference/data-assets/containers/update"},{"title":"Delete a Container","sidebarTitle":"Delete Container","api":"DELETE /v1/containers/{id}","href":"/api-reference/data-assets/containers/delete"},{"title":"Container Versions","sidebarTitle":"Versions","api":"GET /v1/containers/{id}/versions","href":"/api-reference/data-assets/containers/versions"}]}]},{"group":"Search Indexes","pages":[{"title":"Search Indexes","sidebarTitle":"Search Indexes","href":"/api-reference/data-assets/search-indexes/index"},{"title":"List Search Indexes","sidebarTitle":"List Search Indexes","api":"GET /v1/searchIndexes","href":"/api-reference/data-assets/search-indexes/list"},{"title":"Create a Search Index","sidebarTitle":"Create Search Index","api":"POST /v1/searchIndexes","href":"/api-reference/data-assets/search-indexes/create"},{"title":"Retrieve a Search Index","sidebarTitle":"Retrieve Search Index","api":"GET /v1/searchIndexes/{id}","href":"/api-reference/data-assets/search-indexes/retrieve"},{"title":"Update a Search Index","sidebarTitle":"Update Search Index","api":"PUT /v1/searchIndexes","href":"/api-reference/data-assets/search-indexes/update"},{"title":"Delete a Search Index","sidebarTitle":"Delete Search Index","api":"DELETE /v1/searchIndexes/{id}","href":"/api-reference/data-assets/search-indexes/delete"},{"title":"Search Index Versions","sidebarTitle":"Versions","api":"GET /v1/searchIndexes/{id}/versions","href":"/api-reference/data-assets/search-indexes/versions"},{"title":"Followers \u0026 Votes","sidebarTitle":"Followers \u0026 Votes","api":"PUT /v1/searchIndexes/{id}/followers","href":"/api-reference/data-assets/search-indexes/followers-votes"}]},{"group":"API Services","pages":[{"group":"API Collections","pages":[{"title":"API Collections","sidebarTitle":"API Collections","href":"/api-reference/data-assets/api-collections/index"},{"title":"List API Collections","sidebarTitle":"List API Collections","api":"GET /v1/apiCollections","href":"/api-reference/data-assets/api-collections/list"},{"title":"Create an API Collection","sidebarTitle":"Create API Collection","api":"POST /v1/apiCollections","href":"/api-reference/data-assets/api-collections/create"},{"title":"Retrieve an API Collection","sidebarTitle":"Retrieve API Collection","api":"GET /v1/apiCollections/{id}","href":"/api-reference/data-assets/api-collections/retrieve"},{"title":"Update an API Collection","sidebarTitle":"Update API Collection","api":"PUT /v1/apiCollections","href":"/api-reference/data-assets/api-collections/update"},{"title":"Delete an API Collection","sidebarTitle":"Delete API Collection","api":"DELETE /v1/apiCollections/{id}","href":"/api-reference/data-assets/api-collections/delete"},{"title":"API Collection Versions","sidebarTitle":"Versions","api":"GET /v1/apiCollections/{id}/versions","href":"/api-reference/data-assets/api-collections/versions"}]},{"group":"API Endpoints","pages":[{"title":"API Endpoints","sidebarTitle":"API Endpoints","href":"/api-reference/data-assets/api-endpoints/index"},{"title":"List API Endpoints","description":"List all API endpoint entities with optional filtering by collection, method, status code, owner, tag, and pagination support via the Collate REST API.","sidebarTitle":"List API Endpoints","api":"GET /v1/apiEndpoints","href":"/api-reference/data-assets/api-endpoints/list"},{"title":"Create an API Endpoint","sidebarTitle":"Create API Endpoint","api":"POST /v1/apiEndpoints","href":"/api-reference/data-assets/api-endpoints/create"},{"title":"Retrieve an API Endpoint","description":"Retrieve an API endpoint entity by UUID or fully qualified name with optional field expansion for owners, tags, parameters, and metadata using the Collate REST API.","sidebarTitle":"Retrieve API Endpoint","api":"GET /v1/apiEndpoints/{id}","href":"/api-reference/data-assets/api-endpoints/retrieve"},{"title":"Update an API Endpoint","sidebarTitle":"Update API Endpoint","api":"PUT /v1/apiEndpoints","href":"/api-reference/data-assets/api-endpoints/update"},{"title":"Delete an API Endpoint","sidebarTitle":"Delete API Endpoint","api":"DELETE /v1/apiEndpoints/{id}","href":"/api-reference/data-assets/api-endpoints/delete"},{"title":"API Endpoint Versions","sidebarTitle":"Versions","api":"GET /v1/apiEndpoints/{id}/versions","href":"/api-reference/data-assets/api-endpoints/versions"}]}]}]},{"group":"AI Assets","pages":[{"title":"AI Assets","sidebarTitle":"Overview","href":"/api-reference/ai-assets/index"},{"title":"Large Language Models","sidebarTitle":"LLMs","href":"/api-reference/ai-assets/llm"},{"title":"AI Agents","sidebarTitle":"AI Agents","href":"/api-reference/ai-assets/ai-agents"},{"title":"Model Context Protocol","sidebarTitle":"MCP","href":"/api-reference/ai-assets/mcp"},{"title":"AI Applications","sidebarTitle":"AI Applications","href":"/api-reference/ai-assets/ai-applications"},{"title":"Prompt Templates","sidebarTitle":"Prompt Templates","href":"/api-reference/ai-assets/prompt-templates"}]},{"group":"Billing","pages":[{"title":"Billing","sidebarTitle":"Billing","href":"/api-reference/billing"}]},{"group":"Query Runner","pages":[{"title":"Query Runner","sidebarTitle":"Overview","href":"/api-reference/query-runner/index"},{"title":"Query Execution","sidebarTitle":"Execution","href":"/api-reference/query-runner/execution"},{"title":"Admin Configs","sidebarTitle":"Configs","href":"/api-reference/query-runner/configs"},{"title":"Saved Queries","sidebarTitle":"Saved Queries","href":"/api-reference/query-runner/saved-queries"},{"title":"Team Configs","sidebarTitle":"Team Configs","href":"/api-reference/query-runner/team-configs"},{"title":"User Configs","sidebarTitle":"User Configs","href":"/api-reference/query-runner/user-configs"}]},{"group":"Context Plugins","pages":[{"title":"Context Plugins","sidebarTitle":"Context Plugins","href":"/api-reference/context-plugins"}]},{"group":"Data Contracts","pages":[{"title":"Data Contracts","sidebarTitle":"Overview","href":"/api-reference/data-contracts/index"},{"title":"Create a Data Contract","sidebarTitle":"Create","api":"POST /v1/dataContracts","href":"/api-reference/data-contracts/create"},{"title":"List Data Contracts","sidebarTitle":"List","api":"GET /v1/dataContracts","href":"/api-reference/data-contracts/list"},{"title":"Retrieve a Data Contract","sidebarTitle":"Retrieve","api":"GET /v1/dataContracts/{id}","href":"/api-reference/data-contracts/retrieve"},{"title":"Update a Data Contract","sidebarTitle":"Update","api":"PUT /v1/dataContracts","href":"/api-reference/data-contracts/update"},{"title":"Delete a Data Contract","sidebarTitle":"Delete","api":"DELETE /v1/dataContracts/{id}","href":"/api-reference/data-contracts/delete"},{"title":"Data Contract Versions","sidebarTitle":"Versions","api":"GET /v1/dataContracts/{id}/versions","href":"/api-reference/data-contracts/versions"},{"title":"Validate \u0026 Results","sidebarTitle":"Validate \u0026 Results","api":"POST /v1/dataContracts/{id}/validate","href":"/api-reference/data-contracts/validate"},{"title":"Import \u0026 Export","sidebarTitle":"Import / Export","api":"GET /v1/dataContracts/{id}/odcs","href":"/api-reference/data-contracts/odcs"}]},{"group":"Data Governance","pages":[{"title":"Governance","sidebarTitle":"Overview","href":"/api-reference/governance/index"},{"group":"Domains","pages":[{"title":"Domains","sidebarTitle":"Domains","href":"/api-reference/governance/domains/index"},{"title":"List Domains","sidebarTitle":"List Domains","api":"GET /v1/domains","href":"/api-reference/governance/domains/list"},{"title":"Create a Domain","sidebarTitle":"Create Domain","api":"POST /v1/domains","href":"/api-reference/governance/domains/create"},{"title":"Retrieve a Domain","sidebarTitle":"Retrieve Domain","api":"GET /v1/domains/{id}","href":"/api-reference/governance/domains/retrieve"},{"title":"Update a Domain","sidebarTitle":"Update Domain","api":"PUT /v1/domains","href":"/api-reference/governance/domains/update"},{"title":"Delete a Domain","sidebarTitle":"Delete Domain","api":"DELETE /v1/domains/{id}","href":"/api-reference/governance/domains/delete"},{"title":"Domain Versions","sidebarTitle":"Versions","api":"GET /v1/domains/{id}/versions","href":"/api-reference/governance/domains/versions"}]},{"group":"Data Products","pages":[{"title":"Data Products","sidebarTitle":"Data Products","href":"/api-reference/governance/data-products/index"},{"title":"List Data Products","sidebarTitle":"List Data Products","api":"GET /v1/dataProducts","href":"/api-reference/governance/data-products/list"},{"title":"Create a Data Product","sidebarTitle":"Create Data Product","api":"POST /v1/dataProducts","href":"/api-reference/governance/data-products/create"},{"title":"Retrieve a Data Product","sidebarTitle":"Retrieve Data Product","api":"GET /v1/dataProducts/{id}","href":"/api-reference/governance/data-products/retrieve"},{"title":"Update a Data Product","sidebarTitle":"Update Data Product","api":"PUT /v1/dataProducts","href":"/api-reference/governance/data-products/update"},{"title":"Delete a Data Product","sidebarTitle":"Delete Data Product","api":"DELETE /v1/dataProducts/{id}","href":"/api-reference/governance/data-products/delete"},{"title":"Data Product Versions","sidebarTitle":"Versions","api":"GET /v1/dataProducts/{id}/versions","href":"/api-reference/governance/data-products/versions"},{"title":"Ports \u0026 Assets","sidebarTitle":"Ports \u0026 Assets","api":"PUT /v1/dataProducts/{fqn}/assets/add","href":"/api-reference/governance/data-products/ports-assets"}]},{"group":"Metrics","pages":[{"title":"Metrics","sidebarTitle":"Overview","href":"/api-reference/governance/metrics/index"},{"title":"Create a Metric","sidebarTitle":"Create a Metric","api":"POST /v1/metrics","href":"/api-reference/governance/metrics/create"},{"title":"Delete a Metric","sidebarTitle":"Delete a Metric","api":"DELETE /v1/metrics/{id}","href":"/api-reference/governance/metrics/delete"},{"title":"Import and Export Metrics","sidebarTitle":"Import / Export","api":"GET /v1/metrics/name/{name}/export","href":"/api-reference/governance/metrics/import-export"},{"title":"List Metrics","sidebarTitle":"List Metrics","api":"GET /v1/metrics","href":"/api-reference/governance/metrics/list"},{"title":"Retrieve a Metric","sidebarTitle":"Retrieve a Metric","api":"GET /v1/metrics/{id}","href":"/api-reference/governance/metrics/retrieve"},{"title":"Update a Metric","sidebarTitle":"Update a Metric","api":"PUT /v1/metrics","href":"/api-reference/governance/metrics/update"},{"title":"Metric Versions","sidebarTitle":"Metric Versions","api":"GET /v1/metrics/{id}/versions","href":"/api-reference/governance/metrics/versions"}]},{"group":"Glossaries","pages":[{"title":"Glossaries","sidebarTitle":"Glossaries","href":"/api-reference/governance/glossaries/index"},{"title":"List Glossaries","sidebarTitle":"List Glossaries","api":"GET /v1/glossaries","href":"/api-reference/governance/glossaries/list"},{"title":"Create a Glossary","sidebarTitle":"Create Glossary","api":"POST /v1/glossaries","href":"/api-reference/governance/glossaries/create"},{"title":"Retrieve a Glossary","sidebarTitle":"Retrieve Glossary","api":"GET /v1/glossaries/{id}","href":"/api-reference/governance/glossaries/retrieve"},{"title":"Update a Glossary","sidebarTitle":"Update Glossary","api":"PUT /v1/glossaries","href":"/api-reference/governance/glossaries/update"},{"title":"Delete a Glossary","sidebarTitle":"Delete Glossary","api":"DELETE /v1/glossaries/{id}","href":"/api-reference/governance/glossaries/delete"},{"title":"Glossary Versions","sidebarTitle":"Versions","api":"GET /v1/glossaries/{id}/versions","href":"/api-reference/governance/glossaries/versions"}]},{"group":"Glossary Terms","pages":[{"title":"Glossary Terms","sidebarTitle":"Glossary Terms","href":"/api-reference/governance/glossary-terms/index"},{"title":"List Glossary Terms","sidebarTitle":"List Glossary Terms","api":"GET /v1/glossaryTerms","href":"/api-reference/governance/glossary-terms/list"},{"title":"Create a Glossary Term","sidebarTitle":"Create Glossary Term","api":"POST /v1/glossaryTerms","href":"/api-reference/governance/glossary-terms/create"},{"title":"Retrieve a Glossary Term","sidebarTitle":"Retrieve Glossary Term","api":"GET /v1/glossaryTerms/{id}","href":"/api-reference/governance/glossary-terms/retrieve"},{"title":"Update a Glossary Term","sidebarTitle":"Update Glossary Term","api":"PUT /v1/glossaryTerms","href":"/api-reference/governance/glossary-terms/update"},{"title":"Delete a Glossary Term","sidebarTitle":"Delete Glossary Term","api":"DELETE /v1/glossaryTerms/{id}","href":"/api-reference/governance/glossary-terms/delete"},{"title":"Glossary Term Versions","sidebarTitle":"Versions","api":"GET /v1/glossaryTerms/{id}/versions","href":"/api-reference/governance/glossary-terms/versions"}]},{"group":"Classifications","pages":[{"title":"Classifications","sidebarTitle":"Classifications","href":"/api-reference/governance/classifications/index"},{"title":"List Classifications","sidebarTitle":"List Classifications","api":"GET /v1/classifications","href":"/api-reference/governance/classifications/list"},{"title":"Create a Classification","sidebarTitle":"Create Classification","api":"POST /v1/classifications","href":"/api-reference/governance/classifications/create"},{"title":"Retrieve a Classification","sidebarTitle":"Retrieve Classification","api":"GET /v1/classifications/{id}","href":"/api-reference/governance/classifications/retrieve"},{"title":"Update a Classification","sidebarTitle":"Update Classification","api":"PUT /v1/classifications","href":"/api-reference/governance/classifications/update"},{"title":"Delete a Classification","sidebarTitle":"Delete Classification","api":"DELETE /v1/classifications/{id}","href":"/api-reference/governance/classifications/delete"},{"title":"Classification Versions","sidebarTitle":"Versions","api":"GET /v1/classifications/{id}/versions","href":"/api-reference/governance/classifications/versions"}]},{"group":"Tags","pages":[{"title":"Tags","sidebarTitle":"Tags","href":"/api-reference/governance/tags/index"},{"title":"List Tags","sidebarTitle":"List Tags","api":"GET /v1/tags","href":"/api-reference/governance/tags/list"},{"title":"Create a Tag","sidebarTitle":"Create Tag","api":"POST /v1/tags","href":"/api-reference/governance/tags/create"},{"title":"Retrieve a Tag","sidebarTitle":"Retrieve Tag","api":"GET /v1/tags/{id}","href":"/api-reference/governance/tags/retrieve"},{"title":"Update a Tag","sidebarTitle":"Update Tag","api":"PUT /v1/tags","href":"/api-reference/governance/tags/update"},{"title":"Delete a Tag","sidebarTitle":"Delete Tag","api":"DELETE /v1/tags/{id}","href":"/api-reference/governance/tags/delete"},{"title":"Tag Versions","sidebarTitle":"Versions","api":"GET /v1/tags/{id}/versions","href":"/api-reference/governance/tags/versions"}]}]},{"group":"Data Quality","pages":[{"title":"Data Quality","sidebarTitle":"Overview","href":"/api-reference/data-quality/index"},{"group":"Test Definitions","pages":[{"title":"Test Definitions","sidebarTitle":"Test Definitions","href":"/api-reference/data-quality/test-definitions/index"},{"title":"List Test Definitions","sidebarTitle":"List Test Definitions","api":"GET /v1/dataQuality/testDefinitions","href":"/api-reference/data-quality/test-definitions/list"},{"title":"Retrieve a Test Definition","sidebarTitle":"Retrieve Test Definition","api":"GET /v1/dataQuality/testDefinitions/{id}","href":"/api-reference/data-quality/test-definitions/retrieve"},{"title":"Create a Test Definition","sidebarTitle":"Create Test Definition","api":"POST /v1/dataQuality/testDefinitions","href":"/api-reference/data-quality/test-definitions/create"}]},{"group":"Test Suites","pages":[{"title":"Test Suites","sidebarTitle":"Test Suites","href":"/api-reference/data-quality/test-suites/index"},{"title":"List Test Suites","sidebarTitle":"List Test Suites","api":"GET /v1/dataQuality/testSuites","href":"/api-reference/data-quality/test-suites/list"},{"title":"Create a Test Suite","sidebarTitle":"Create Test Suite","api":"POST /v1/dataQuality/testSuites","href":"/api-reference/data-quality/test-suites/create"},{"title":"Retrieve a Test Suite","sidebarTitle":"Retrieve Test Suite","api":"GET /v1/dataQuality/testSuites/{id}","href":"/api-reference/data-quality/test-suites/retrieve"},{"title":"Update a Test Suite","sidebarTitle":"Update Test Suite","api":"PUT /v1/dataQuality/testSuites","href":"/api-reference/data-quality/test-suites/update"},{"title":"Delete a Test Suite","sidebarTitle":"Delete Test Suite","api":"DELETE /v1/dataQuality/testSuites/{id}","href":"/api-reference/data-quality/test-suites/delete"},{"title":"Test Suite Versions","sidebarTitle":"Versions","api":"GET /v1/dataQuality/testSuites/{id}/versions","href":"/api-reference/data-quality/test-suites/versions"}]},{"group":"Test Cases","pages":[{"title":"Test Cases","sidebarTitle":"Test Cases","href":"/api-reference/data-quality/test-cases/index"},{"title":"List Test Cases","sidebarTitle":"List Test Cases","api":"GET /v1/dataQuality/testCases","href":"/api-reference/data-quality/test-cases/list"},{"title":"Create a Test Case","sidebarTitle":"Create Test Case","api":"POST /v1/dataQuality/testCases","href":"/api-reference/data-quality/test-cases/create"},{"title":"Retrieve a Test Case","sidebarTitle":"Retrieve Test Case","api":"GET /v1/dataQuality/testCases/{id}","href":"/api-reference/data-quality/test-cases/retrieve"},{"title":"Update a Test Case","sidebarTitle":"Update Test Case","api":"PUT /v1/dataQuality/testCases","href":"/api-reference/data-quality/test-cases/update"},{"title":"Delete a Test Case","sidebarTitle":"Delete Test Case","api":"DELETE /v1/dataQuality/testCases/{id}","href":"/api-reference/data-quality/test-cases/delete"},{"title":"Test Case Versions","sidebarTitle":"Versions","api":"GET /v1/dataQuality/testCases/{id}/versions","href":"/api-reference/data-quality/test-cases/versions"},{"title":"Test Case Results","sidebarTitle":"Results","api":"GET /v1/dataQuality/testCases/testCaseResults/{fqn}","href":"/api-reference/data-quality/test-cases/results"}]}]},{"group":"Alerts","pages":[{"title":"Alerts","sidebarTitle":"Overview","href":"/api-reference/alerts/index"},{"title":"Create an Alert","sidebarTitle":"Create Alert","api":"POST /v1/events/subscriptions","href":"/api-reference/alerts/create"},{"title":"List and Retrieve Alerts","sidebarTitle":"List and Retrieve","api":"GET /v1/events/subscriptions","href":"/api-reference/alerts/list"},{"title":"Update an Alert","sidebarTitle":"Update Alert","api":"PUT /v1/events/subscriptions","href":"/api-reference/alerts/update"},{"title":"Delete an Alert","sidebarTitle":"Delete Alert","api":"DELETE /v1/events/subscriptions/{id}","href":"/api-reference/alerts/delete"}]},{"group":"Incidents","pages":[{"title":"Incidents","sidebarTitle":"Overview","href":"/api-reference/incidents/index"},{"title":"List and Retrieve Incidents","sidebarTitle":"List and Retrieve","api":"GET /v1/tasks","href":"/api-reference/incidents/list"},{"title":"Change Incident Status","sidebarTitle":"Change Status","api":"POST /v1/tasks/{id}/resolve","href":"/api-reference/incidents/update-status"}]},{"group":"Discovery","pages":[{"title":"Discovery","sidebarTitle":"Overview","href":"/api-reference/discovery/index"},{"title":"Search Entities","sidebarTitle":"Search","api":"GET /v1/search/query","href":"/api-reference/discovery/search"},{"title":"Field Query","sidebarTitle":"Field Query","api":"GET /v1/search/fieldQuery","href":"/api-reference/discovery/field-query"}]},{"group":"Lineage","pages":[{"title":"Lineage","sidebarTitle":"Overview","href":"/api-reference/lineage/index"},{"title":"Get Lineage","sidebarTitle":"Get Lineage","api":"GET /v1/lineage/{entityType}/{id}","href":"/api-reference/lineage/get"},{"title":"Add Lineage","sidebarTitle":"Add Lineage","api":"PUT /v1/lineage","href":"/api-reference/lineage/add"},{"title":"Delete Lineage","sidebarTitle":"Delete Lineage","api":"DELETE /v1/lineage/{fromEntity}/{fromId}/{toEntity}/{toId}","href":"/api-reference/lineage/delete"},{"title":"Export Lineage","sidebarTitle":"Export Lineage","api":"GET /v1/lineage/export","href":"/api-reference/lineage/export"}]},{"group":"Teams \u0026 Users","pages":[{"title":"Teams \u0026 Users","sidebarTitle":"Overview","href":"/api-reference/teams-and-users/index"},{"group":"Users","pages":[{"title":"Users","sidebarTitle":"Users","href":"/api-reference/teams-and-users/users/index"},{"title":"List Users","sidebarTitle":"List Users","api":"GET /v1/users","href":"/api-reference/teams-and-users/users/list"},{"title":"Create a User","sidebarTitle":"Create User","api":"POST /v1/users","href":"/api-reference/teams-and-users/users/create"},{"title":"Retrieve a User","sidebarTitle":"Retrieve User","api":"GET /v1/users/{id}","href":"/api-reference/teams-and-users/users/retrieve"},{"title":"Update a User","sidebarTitle":"Update User","api":"PUT /v1/users","href":"/api-reference/teams-and-users/users/update"},{"title":"Delete a User","sidebarTitle":"Delete User","api":"DELETE /v1/users/{id}","href":"/api-reference/teams-and-users/users/delete"},{"title":"User Versions","sidebarTitle":"Versions","api":"GET /v1/users/{id}/versions","href":"/api-reference/teams-and-users/users/versions"}]},{"group":"Teams","pages":[{"title":"Teams","sidebarTitle":"Teams","href":"/api-reference/teams-and-users/teams/index"},{"title":"List Teams","sidebarTitle":"List Teams","api":"GET /v1/teams","href":"/api-reference/teams-and-users/teams/list"},{"title":"Create a Team","sidebarTitle":"Create Team","api":"POST /v1/teams","href":"/api-reference/teams-and-users/teams/create"},{"title":"Retrieve a Team","sidebarTitle":"Retrieve Team","api":"GET /v1/teams/{id}","href":"/api-reference/teams-and-users/teams/retrieve"},{"title":"Update a Team","sidebarTitle":"Update Team","api":"PUT /v1/teams","href":"/api-reference/teams-and-users/teams/update"},{"title":"Delete a Team","sidebarTitle":"Delete Team","api":"DELETE /v1/teams/{id}","href":"/api-reference/teams-and-users/teams/delete"},{"title":"Team Versions","sidebarTitle":"Versions","api":"GET /v1/teams/{id}/versions","href":"/api-reference/teams-and-users/teams/versions"}]}]}]},{"title":"OpenMetadata Standards","href":"/sdk/openmetadata-standards"}]}]}]}]},"basePath":"","title":"Create an API Endpoint - Collate Documentation","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js"]}