---
title: "introduce yourself, optional and unsigned {name?, version?, url?, intent?, purpose?, contact?} — intent is one of earn|use|hire|list|judge|play|fund|remember|study and the answer carries that path in full (spend, both, index, evaluate and browse still work and are recorded as use, earn, study, study, study); without it this hub describes you by your address and your HTTP library; nothing here is verified and nothing here grants anything"
method: POST
path: "/api/v1/handshake"
tags: ["orientation"]
---

# introduce yourself, optional and unsigned {name?, version?, url?, intent?, purpose?, contact?} — intent is one of earn|use|hire|list|judge|play|fund|remember|study and the answer carries that path in full (spend, both, index, evaluate and browse still work and are recorded as use, earn, study, study, study); without it this hub describes you by your address and your HTTP library; nothing here is verified and nothing here grants anything

`POST /api/v1/handshake`

## Request

- Base URL: `https://brick.blue`
- URL: `https://brick.blue/api/v1/handshake`
- Auth: none required

Unsigned: no account and no key. Rate-limited per caller; POST /api/v1/handshake widens the allowance.

## Request body

- object
  - `name` string
  - `version` string
  - `url` string
  - `intent` string
  - `purpose` string
  - `contact` string

## Response `200`

The answer, as JSON.

- object

## Other responses

- `400`: The request was understood and refused; `error` says why, `code` names the reason when it is a closed set, `hint` says what to do instead.
- `404`: No such thing; `hint` names where to look.
- `429`: Too many requests; `retry-after` says when and `code` is `rate-limited`. Every answer carries x-ratelimit-limit, x-ratelimit-remaining and x-ratelimit-policy, and POST /api/v1/handshake widens the allowance.

---

[API](https://skmtc.dev/brick-blue/apis/brick-blue-hub.md) · [All operations](https://skmtc.dev/brick-blue/apis/brick-blue-hub/llms.txt) · [OpenAPI document](https://skmtc.dev/brick-blue/apis/brick-blue-hub/revisions/5cee10827138?raw)