> For the complete documentation index, see [llms.txt](https://developer.celigo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.celigo.com/api/api-reference/http-connector-endpoints.md).

# HTTP Connector Endpoints

HTTP Connector Endpoints define the individual API operations (method + URI) available under an HTTP Connector Resource. Each endpoint specifies its HTTP method, relative URI template, query/path parameter definitions, and supported-by rules that control how exports and imports are pre-configured when users select this endpoint.

Endpoints are classified by `supportedBy.type`:

* **export** — reads data from the target system.
* **import** — writes data to the target system.

### HTTP connector endpoint schema

## The HTTPConnectorEndpoint object

```json
{"openapi":"3.2.0","info":{"title":"HTTP Connector Endpoints","version":"1.0.0"},"components":{"schemas":{"HTTPConnectorEndpoint":{"type":"object","required":["_id","name","method","relativeURI","published","createdAt","lastModified"],"description":"HTTP Connector Endpoint object as returned by the detail (by-ID) endpoint.","allOf":[{"$ref":"#/components/schemas/HTTPConnectorEndpointBase"},{"$ref":"#/components/schemas/ResourceResponse"},{"type":"object","properties":{"_userId":{"type":"string","format":"objectId","description":"Owner user id","readOnly":true},"metadata":{"type":"object","readOnly":true,"description":"Endpoint metadata used by Data Intelligence tooling. Returned\nonly by the detail (by-ID) endpoint — list responses omit it.","properties":{"di":{"type":"object","description":"Data Intelligence attributes for this endpoint.","properties":{"isListEndpoint":{"type":"boolean","description":"When true, the endpoint returns a list of records rather than a single record."},"responseFields":{"type":"array","description":"Fields Data Intelligence expects in this endpoint's response records.","items":{"type":"object","properties":{"id":{"type":"string","description":"Field path within a response record."},"dataType":{"type":"string","description":"Data type of the field."}}}}}}}}}}]},"HTTPConnectorEndpointBase":{"type":"object","description":"Writable fields shared by the request and response schemas.","properties":{"name":{"type":"string","description":"Human-readable name for this endpoint","maxLength":255},"description":{"type":"string","description":"Optional endpoint description","maxLength":10240},"published":{"type":"boolean","description":"When true, this endpoint is published and available for use."},"isBlob":{"type":"boolean","description":"When true, this endpoint handles binary/blob data.","default":false},"isMappingRequired":{"type":"boolean","description":"When true, field mapping is required for this endpoint.","default":false},"_httpConnectorResourceIds":{"type":"array","description":"References to HTTP Connector Resources associated with this endpoint","items":{"type":"string","format":"objectId"}},"method":{"type":"string","enum":["GET","PUT","POST","PATCH","DELETE","HEAD"],"description":"HTTP method for this endpoint. Required on save; lowercase input is\nuppercased automatically."},"relativeURI":{"type":"string","description":"Relative URI template for this endpoint"},"mergePostBodyToPagingPostBody":{"type":"boolean","description":"When true, merges the postBody into pagingPostBody for paginated requests.","default":false},"queryParameters":{"type":"array","description":"Query parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the request query string."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"description":"UI input type used to collect the parameter value."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name","label"]}},"pathParameters":{"type":"array","description":"Path parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the `relativeURI` template."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"description":"UI input type used to collect the parameter value."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name","label"]}},"resourceFields":{"type":"array","description":"Resource field definitions for this endpoint","items":{"type":"object","properties":{"type":{"type":"string","enum":["inclusion","exclusion"],"description":"Whether `fields` lists the fields to include or to exclude."},"fields":{"type":"array","description":"Field names the inclusion or exclusion rule applies to.","items":{"type":"string"}},"_httpConnectorResourceId":{"type":"string","format":"objectId","description":"HTTP Connector Resource these field rules apply to."}},"required":["type","fields","_httpConnectorResourceId"]}},"supportedBy":{"type":"object","description":"Supported-by configuration for this endpoint (framework-defined)","properties":{"type":{"type":"string","enum":["import","export"],"description":"Whether this endpoint is consumed as an import or an export."},"conditions":{"type":"array","description":"Expression-based filters that control when entries in `preConfiguredFields` and `fieldsUserMustSet` apply.","items":{"type":"object","additionalProperties":true}},"preConfiguredFields":{"type":"array","description":"Fields automatically set to predefined values on the generated export or import. Not editable by the user.","items":{"type":"object","additionalProperties":true}},"fieldsUserMustSet":{"type":"array","description":"Fields the user must provide values for on the generated export or import.","items":{"type":"object","additionalProperties":true}},"fieldsToUnset":{"type":"array","description":"Dot-notation paths of fields to remove from the generated export or import configuration.","items":{"type":"string"}},"pathParameterToIdentifyExisting":{"type":"string","description":"Path parameter whose value identifies an existing record in the target application."},"lookupToIdentifyExisting":{"type":"object","description":"Lookup used to determine whether a record already exists in the target application.","properties":{"_httpConnectorEndpointId":{"type":"string","format":"objectId","description":"HTTP Connector Endpoint used to perform the lookup."},"extract":{"type":"string","description":"Path in the lookup response from which to extract the existing record's identifier."}}}}}}},"ResourceResponse":{"type":"object","description":"Response","properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the resource. Format is a 24-character hexadecimal string."},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was created. Set automatically and cannot be modified."},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was last updated. Changes whenever any property is modified."},"deletedAt":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"Timestamp when the resource was soft-deleted. When null or absent, the resource is active."}},"required":["_id"]}}}}
```

## List HTTP Connector Endpoints for a connector resource

> Returns all endpoints defined under the given HTTP Connector Resource.\
> The list response is abridged — only \`\_id\`, \`name\`, \`createdAt\`, and\
> \`lastModified\` are returned. Use the by-ID endpoint for the full object\
> including \`method\`, \`relativeURI\`, and \`supportedBy\`.

```json
{"openapi":"3.2.0","info":{"title":"HTTP Connector Endpoints","version":"1.0.0"},"tags":[{"name":"HTTP Connector Endpoints","description":"HTTP Connector Endpoints define the individual API operations (method +\nURI) available under an HTTP Connector Resource. Each endpoint specifies\nits HTTP method, relative URI template, query/path parameter definitions,\nand supported-by rules that control how exports and imports are\npre-configured when users select this endpoint.\n\nEndpoints are classified by `supportedBy.type`:\n- **export** — reads data from the target system.\n- **import** — writes data to the target system.\n\n## HTTP connector endpoint schema\n\n{% openapi-schemas spec=\"httpconnectorendpoint\" schemas=\"HTTPConnectorEndpoint\" grouped=\"true\" %}"}],"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"},{"url":"https://api.au.integrator.io","description":"Production (AU region)"},{"url":"https://api.ca.integrator.io","description":"Production (CA region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"After":{"name":"after","in":"query","required":false,"description":"Opaque cursor for forward pagination. Pass the value from the `Link`\nresponse header (`rel=\"next\"`) to fetch the next page.","schema":{"type":"string"}}},"schemas":{"ListItem":{"type":"object","description":"Abridged HTTP Connector Endpoint returned in list responses. Only\nincludes identity and timestamp fields. Use the by-ID endpoint for\nthe full object including method, relativeURI, and supportedBy.","properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the resource. Format is a 24-character hexadecimal string."},"name":{"type":"string","description":"Human-readable name for this endpoint."},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was created. Set automatically and cannot be modified."},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was last updated. Changes whenever any property is modified."}}},"Error":{"type":"object","description":"Standard error response envelope returned by integrator.io APIs.","properties":{"errors":{"type":"array","description":"List of errors that occurred while processing the request.","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"Machine-readable error code. Usually a string like\n`invalid_ref`, `missing_required_field`, or `unauthorized`;\nmay be an **integer** when the error mirrors an upstream HTTP\nstatus (e.g. `500`) — most commonly returned by connection-ping\nand adaptor-proxy responses."},"message":{"type":"string","description":"Human-readable description of the error."},"field":{"type":"string","description":"Optional pointer to the document field that caused the error.\nUsed by structural validation errors (`missing_required_field`,\n`invalid_ref`) to indicate which field is at fault\n(e.g. `_id`, `type`, `http.baseURI`)."},"source":{"type":"string","description":"Optional origin layer for the error — e.g. `application` when\nthe error came from the remote system the adaptor called,\n`connector` when the adaptor itself rejected the request."}},"required":["message"]}}},"required":["errors"]}},"responses":{"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n  is invalid, revoked, or expired."}},"required":["message"]}}}},"404-not-found":{"description":"Not found. The requested resource does not exist or is not visible to the caller.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/httpconnectorendpoints":{"get":{"operationId":"listHttpConnectorEndpoints","tags":["HTTP Connector Endpoints"],"summary":"List HTTP Connector Endpoints for a connector resource","description":"Returns all endpoints defined under the given HTTP Connector Resource.\nThe list response is abridged — only `_id`, `name`, `createdAt`, and\n`lastModified` are returned. Use the by-ID endpoint for the full object\nincluding `method`, `relativeURI`, and `supportedBy`.","parameters":[{"name":"limit","in":"query","description":"Maximum number of records to return per page.","schema":{"type":"integer","minimum":1}},{"$ref":"#/components/parameters/After"},{"in":"path","name":"_httpConnectorId","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector ID."},{"in":"path","name":"_httpConnectorResourceId","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector Resource ID."},{"in":"query","name":"supportedByType","schema":{"type":"string","enum":["import","export"]},"description":"Filter endpoints by their supported-by direction."},{"in":"query","name":"publishedOnly","schema":{"type":"boolean"},"description":"When true, only return published endpoints."}],"responses":{"200":{"description":"Successfully retrieved list of HTTP Connector Endpoints.","headers":{"Link":{"description":"RFC-5988 pagination links. When more pages remain, includes a `<...>; rel=\"next\"` entry;\nabsent on the final page.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ListItem"}}}}},"204":{"description":"No endpoints exist for this resource (or none match the filter)."},"401":{"$ref":"#/components/responses/401-unauthorized"},"404":{"$ref":"#/components/responses/404-not-found"}}}}}}
```

## Get an HTTP connector endpoint

> Retrieves the full HTTP Connector Endpoint including \`method\`,\
> \`relativeURI\`, \`queryParameters\`, \`pathParameters\`, and \`supportedBy\`\
> details omitted from the list endpoint.

```json
{"openapi":"3.2.0","info":{"title":"HTTP Connector Endpoints","version":"1.0.0"},"tags":[{"name":"HTTP Connector Endpoints","description":"HTTP Connector Endpoints define the individual API operations (method +\nURI) available under an HTTP Connector Resource. Each endpoint specifies\nits HTTP method, relative URI template, query/path parameter definitions,\nand supported-by rules that control how exports and imports are\npre-configured when users select this endpoint.\n\nEndpoints are classified by `supportedBy.type`:\n- **export** — reads data from the target system.\n- **import** — writes data to the target system.\n\n## HTTP connector endpoint schema\n\n{% openapi-schemas spec=\"httpconnectorendpoint\" schemas=\"HTTPConnectorEndpoint\" grouped=\"true\" %}"}],"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"},{"url":"https://api.au.integrator.io","description":"Production (AU region)"},{"url":"https://api.ca.integrator.io","description":"Production (CA region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"HTTPConnectorEndpoint":{"type":"object","required":["_id","name","method","relativeURI","published","createdAt","lastModified"],"description":"HTTP Connector Endpoint object as returned by the detail (by-ID) endpoint.","allOf":[{"$ref":"#/components/schemas/HTTPConnectorEndpointBase"},{"$ref":"#/components/schemas/ResourceResponse"},{"type":"object","properties":{"_userId":{"type":"string","format":"objectId","description":"Owner user id","readOnly":true},"metadata":{"type":"object","readOnly":true,"description":"Endpoint metadata used by Data Intelligence tooling. Returned\nonly by the detail (by-ID) endpoint — list responses omit it.","properties":{"di":{"type":"object","description":"Data Intelligence attributes for this endpoint.","properties":{"isListEndpoint":{"type":"boolean","description":"When true, the endpoint returns a list of records rather than a single record."},"responseFields":{"type":"array","description":"Fields Data Intelligence expects in this endpoint's response records.","items":{"type":"object","properties":{"id":{"type":"string","description":"Field path within a response record."},"dataType":{"type":"string","description":"Data type of the field."}}}}}}}}}}]},"HTTPConnectorEndpointBase":{"type":"object","description":"Writable fields shared by the request and response schemas.","properties":{"name":{"type":"string","description":"Human-readable name for this endpoint","maxLength":255},"description":{"type":"string","description":"Optional endpoint description","maxLength":10240},"published":{"type":"boolean","description":"When true, this endpoint is published and available for use."},"isBlob":{"type":"boolean","description":"When true, this endpoint handles binary/blob data.","default":false},"isMappingRequired":{"type":"boolean","description":"When true, field mapping is required for this endpoint.","default":false},"_httpConnectorResourceIds":{"type":"array","description":"References to HTTP Connector Resources associated with this endpoint","items":{"type":"string","format":"objectId"}},"method":{"type":"string","enum":["GET","PUT","POST","PATCH","DELETE","HEAD"],"description":"HTTP method for this endpoint. Required on save; lowercase input is\nuppercased automatically."},"relativeURI":{"type":"string","description":"Relative URI template for this endpoint"},"mergePostBodyToPagingPostBody":{"type":"boolean","description":"When true, merges the postBody into pagingPostBody for paginated requests.","default":false},"queryParameters":{"type":"array","description":"Query parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the request query string."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"description":"UI input type used to collect the parameter value."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name","label"]}},"pathParameters":{"type":"array","description":"Path parameter definitions","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name as it appears in the `relativeURI` template."},"label":{"type":"string","description":"Label shown to users in the UI for this parameter."},"description":{"type":"string","description":"Help text shown to users explaining what this parameter does."},"required":{"type":"boolean","description":"When true, the user must supply a value for this parameter."},"dataType":{"type":"string","enum":["input","date","select","multiselect","array","number"],"description":"UI input type used to collect the parameter value."},"values":{"type":"array","description":"Predefined values offered when `dataType` is `select` or `multiselect`.","items":{"type":"string"}}},"required":["name","label"]}},"resourceFields":{"type":"array","description":"Resource field definitions for this endpoint","items":{"type":"object","properties":{"type":{"type":"string","enum":["inclusion","exclusion"],"description":"Whether `fields` lists the fields to include or to exclude."},"fields":{"type":"array","description":"Field names the inclusion or exclusion rule applies to.","items":{"type":"string"}},"_httpConnectorResourceId":{"type":"string","format":"objectId","description":"HTTP Connector Resource these field rules apply to."}},"required":["type","fields","_httpConnectorResourceId"]}},"supportedBy":{"type":"object","description":"Supported-by configuration for this endpoint (framework-defined)","properties":{"type":{"type":"string","enum":["import","export"],"description":"Whether this endpoint is consumed as an import or an export."},"conditions":{"type":"array","description":"Expression-based filters that control when entries in `preConfiguredFields` and `fieldsUserMustSet` apply.","items":{"type":"object","additionalProperties":true}},"preConfiguredFields":{"type":"array","description":"Fields automatically set to predefined values on the generated export or import. Not editable by the user.","items":{"type":"object","additionalProperties":true}},"fieldsUserMustSet":{"type":"array","description":"Fields the user must provide values for on the generated export or import.","items":{"type":"object","additionalProperties":true}},"fieldsToUnset":{"type":"array","description":"Dot-notation paths of fields to remove from the generated export or import configuration.","items":{"type":"string"}},"pathParameterToIdentifyExisting":{"type":"string","description":"Path parameter whose value identifies an existing record in the target application."},"lookupToIdentifyExisting":{"type":"object","description":"Lookup used to determine whether a record already exists in the target application.","properties":{"_httpConnectorEndpointId":{"type":"string","format":"objectId","description":"HTTP Connector Endpoint used to perform the lookup."},"extract":{"type":"string","description":"Path in the lookup response from which to extract the existing record's identifier."}}}}}}},"ResourceResponse":{"type":"object","description":"Response","properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the resource. Format is a 24-character hexadecimal string."},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was created. Set automatically and cannot be modified."},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the resource was last updated. Changes whenever any property is modified."},"deletedAt":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"Timestamp when the resource was soft-deleted. When null or absent, the resource is active."}},"required":["_id"]},"Error":{"type":"object","description":"Standard error response envelope returned by integrator.io APIs.","properties":{"errors":{"type":"array","description":"List of errors that occurred while processing the request.","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"Machine-readable error code. Usually a string like\n`invalid_ref`, `missing_required_field`, or `unauthorized`;\nmay be an **integer** when the error mirrors an upstream HTTP\nstatus (e.g. `500`) — most commonly returned by connection-ping\nand adaptor-proxy responses."},"message":{"type":"string","description":"Human-readable description of the error."},"field":{"type":"string","description":"Optional pointer to the document field that caused the error.\nUsed by structural validation errors (`missing_required_field`,\n`invalid_ref`) to indicate which field is at fault\n(e.g. `_id`, `type`, `http.baseURI`)."},"source":{"type":"string","description":"Optional origin layer for the error — e.g. `application` when\nthe error came from the remote system the adaptor called,\n`connector` when the adaptor itself rejected the request."}},"required":["message"]}}},"required":["errors"]}},"responses":{"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n  is invalid, revoked, or expired."}},"required":["message"]}}}},"403-forbidden":{"description":"Forbidden. The authenticated caller does not have permission to perform this operation.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404-not-found":{"description":"Not found. The requested resource does not exist or is not visible to the caller.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/httpconnectors/{_httpConnectorId}/{_httpConnectorResourceId}/{_id}":{"get":{"operationId":"getHttpConnectorEndpointById","tags":["HTTP Connector Endpoints"],"summary":"Get an HTTP connector endpoint","description":"Retrieves the full HTTP Connector Endpoint including `method`,\n`relativeURI`, `queryParameters`, `pathParameters`, and `supportedBy`\ndetails omitted from the list endpoint.","parameters":[{"in":"path","name":"_httpConnectorId","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector ID."},{"in":"path","name":"_httpConnectorResourceId","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector Resource ID."},{"in":"path","name":"_id","required":true,"schema":{"type":"string","format":"objectId"},"description":"HTTP Connector Endpoint ID."}],"responses":{"200":{"description":"HTTP Connector Endpoint retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPConnectorEndpoint"}}}},"401":{"$ref":"#/components/responses/401-unauthorized"},"403":{"$ref":"#/components/responses/403-forbidden"},"404":{"$ref":"#/components/responses/404-not-found"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.celigo.com/api/api-reference/http-connector-endpoints.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.