> For the complete documentation index, see [llms.txt](https://docs.stoobly.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stoobly.com/experimental/experimental-features/endpoints.md).

# Endpoints

{% hint style="info" %}
**Use Case**

* Required for marking a request component as optional for mock response matching
  {% endhint %}

## Types of Endpoints

### Fixed Endpoint

A fixed endpoint has a static path that will exactly match a request's path.

* Matching against a fixed endpoint has the highest priority level

### Aliased Endpoint

An aliased endpoint has one or more aliases in its path. When an endpoint is aliased, fuzzy matching is applied when grouping requests.

* Matching against an aliased endpoint has lower priority than matching against a fixed endpoint
* Aliased endpoints with a lower number of aliased path segments will have higher matching priority over aliased endpoints with a higher number of aliased path segments

## Examples

Given the following endpoint patterns:

1. `/users/1`
2. `/users/:userId`
3. `/:organizationId/:userId`\\

### Example 1

A request with path `/users/1` will be grouped into **endpoint 1** because it is a fixed endpoint.

### Example 2

A request with path `/users/2` will be grouped into **endpoint 2** (one aliased path component) and not endpoint 3 (two aliased path components) because it has a lower number of aliased path components.

### Example 3

A request with path `/stoobly/2` will be grouped into **endpoint 3**

## **How To Create**

### Method 1

In the top right corner of the endpoints page, select the plus icon button.

<figure><img src="/files/u8QzxjI2aos8mTlkX3oR" alt=""><figcaption><p>Endpoints Page</p></figcaption></figure>

### Method 2

On the requests page, right-click a request and in the dropdown menu, select **Make Endpoint**.

<figure><img src="/files/PjC78QLtc9XdCYmm9p4e" alt=""><figcaption><p>Requests Page Dropdown</p></figcaption></figure>


---

# 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://docs.stoobly.com/experimental/experimental-features/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.