Skip to content

Getting Started ​

Danger

This API is in beta and may change without notice.

Work with your YouViCo projects from an AI app through MCP, or from your own tools through the API.

Let AI set it up ​

Paste this into an AI app or coding assistant, such as Claude, ChatGPT, Claude Code, or Cursor, and it handles the setup for you.

text
Set up YouViCo for me by following https://developers.youvico.com/guides/getting-started.
- If you can connect MCP servers, add https://api.youvico.com/mcp as a remote MCP server and walk me through signing in.
- If I want code instead, have me create an API key, then build the integration with the guides and API reference at https://developers.youvico.com. Keep the key in the YOUVICO_API_KEY environment variable.
Reply in the language I write in.

Connect with MCP ​

Connect an AI app that supports MCP, such as Claude or ChatGPT, and ask about your projects in plain language.

  1. In your AI app, add a custom MCP connector with this URL:

    https://api.youvico.com/mcp
  2. Sign in to YouViCo, then choose a workspace and the scopes to allow.

  3. Ask the app, for example, "What comments were left on the Launch Campaign project?"

See MCP for what the app can do and how to disconnect it.

Use the API ​

Call the API directly from your own tools with an API key.

1. Create an API key ​

In the YouViCo app, go to Settings → API Keys and create a key for your workspace. Choose the scopes your integration needs.

Warning

The key is shown only once. Copy it and store it somewhere safe.

2. Check the key ​

Send the key in the Authorization header and call Ping:

bash
curl 'https://api.youvico.com/api/ping' \
  -H 'Authorization: Bearer YOUR_API_KEY'

The response shows the workspace the key belongs to and its scopes.

3. Make your first request ​

Search the projects in that workspace:

bash
curl -X QUERY 'https://api.youvico.com/api/projects' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "keyword": "launch" }'
json
{
  "data": [
    {
      "id": "bdbff5de-96d7-468f-9db0-85fe28bd6b62",
      "name": "Launch Campaign"
    }
  ],
  "page": {
    "next": null,
    "prev": null
  }
}

Next steps ​