> For the complete documentation index, see [llms.txt](https://docs.geosamples.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.geosamples.org/api/readme.md).

# Overview

Call the SESAR API to register, find, and update sample metadata.

This section is for software that talks to SESAR. The **OpenAPI reference** (next in the sidebar) is the contract: every path, field, and status code. The pages after it are short how-tos for the workflows the spec does not spell out in order.

| Environment               | Base URL                                  |
| ------------------------- | ----------------------------------------- |
| **Production**            | `https://api.geosamples.org/api/`         |
| **Sandbox** (for testing) | `https://api-sandbox.geosamples.org/api/` |

Use the sandbox host while you develop and test. Use production only when you intend to create or change real sample records.

Send JSON. Writes and private reads need `Authorization: Bearer` plus an access token from [Authentication](/api/authentication.md). Listing published samples does not.

| If you want to…             | Start here                                                               |
| --------------------------- | ------------------------------------------------------------------------ |
| Get a JWT                   | [Authentication](/api/authentication.md)                                 |
| Mint an IGSN                | [Register a sample](/api/register-a-sample.md)                           |
| Search or load one sample   | [Find or fetch a sample](/api/find-or-fetch-a-sample.md)                 |
| Change metadata             | [Update a sample](/api/update-a-sample.md)                               |
| Move off `upload.php` / XML | [Migrating from v1 web services](/api/migrating-from-v1-web-services.md) |
| See every field             | OpenAPI reference, grouped by tag                                        |

Allowed values live in the **Vocabularies** section. What each sample field means, and which ones are required, is in **Metadata Schema**.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.geosamples.org/api/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.