> For the complete documentation index, see [llms.txt](https://mastodon.gitbook.io/mastodon/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mastodon.gitbook.io/mastodon/methods/apps.md).

# apps

## Create an application

<mark style="color:green;">`POST`</mark> `https://mastodon.example/api/v1/apps`

Create a new application to obtain OAuth2 credentials.\
\
**Returns:** Application, with `client_id` and `client_secret`\
**OAuth:** Public\
**Version history:** \
0.0.0 - added\
2.7.2 - now returns vapid\_key<br>

#### Request Body

| Name           | Type   | Description                                                                                                                                                                                     |
| -------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| client\_name   | string | A name for your application                                                                                                                                                                     |
| redirect\_uris | string | Where the user should be redirected after authorization. To display the authorization code to the user instead of redirecting to a web page, use `urn:ietf:wg:oauth:2.0:oob` in this parameter. |
| scopes         | string | Space separated list of scopes. If none is provided, defaults to `read`.                                                                                                                        |
| website        | string | A URL to the homepage of your app                                                                                                                                                               |

{% tabs %}
{% tab title="200 Store the client\_id and client\_secret in your cache, as these will be used to obtain OAuth tokens." %}

```javascript
{
  "id": "563419",
  "name": "test app",
  "website": null,
  "redirect_uri": "urn:ietf:wg:oauth:2.0:oob",
  "client_id": "TWhM-tNSuncnqN7DBJmoyeLnk6K3iJJ71KKXxgL1hPM",
  "client_secret": "ZEaFUFmF0umgBX1qKJDjaU99Q31lDkOU8NutzTOoliw",
  "vapid_key": "BCk-QqERU0q-CfYZjcuB6lnyyOYfJ2AifKqfeGIm7Z-HiTU5T9eTG5GxVA0_OH5mMlI4UkkDTpaZwozy0TzdZ2M="
}
```

{% endtab %}

{% tab title="422 If a required parameter is missing or improperly formatted, the request will fail." %}

```javascript
{
  "error": "Validation failed: Redirect URI must be an absolute URI."
}
```

{% endtab %}
{% endtabs %}

## Verify your app works

<mark style="color:blue;">`GET`</mark> `https://mastodon.example/api/v1/apps/verify_credentials`

Confirm that the app's OAuth2 credentials work.\
\
**Returns:** Application\
**OAuth level:** App token\
**Version history:** \
2.0.0 - added\
2.7.2 - now returns vapid\_key

#### Headers

| Name          | Type   | Description         |
| ------------- | ------ | ------------------- |
| Authorization | string | Bearer \<app token> |

{% tabs %}
{% tab title="200 If the Authorization header was provided with a valid token, you should see your app returned as an Application entity." %}

```javascript
{
  "name": "test app",
  "website": null,
  "vapid_key": "BCk-QqERU0q-CfYZjcuB6lnyyOYfJ2AifKqfeGIm7Z-HiTU5T9eTG5GxVA0_OH5mMlI4UkkDTpaZwozy0TzdZ2M="
}
```

{% endtab %}

{% tab title="401 If the Authorization header contains an invalid token, is malformed, or is not present, an error will be returned indicating an authorization failure." %}

```javascript
{
  "error": "The access token is invalid"
}
```

{% endtab %}
{% endtabs %}