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

# Introduction

Welcome to the official documentation of the Becard REST API! This API provides a powerful and flexible interface to access the features and data of becard.me, enabling developers to create innovative applications and services based on our high-quality digital business cards.

**About Becard** 

Becard is a leading platform for digital business cards, allowing users to create, share, and manage professional and impressive digital business cards online and combine them with physical products. Our API empowers developers to harness the benefits of our platform and build customized solutions that can elevate the way people maintain their contacts and exchange business information to a new level.

**What Does This Documentation Offer?** 

In this documentation, you will find comprehensive information and examples to assist you in integrating our REST API into your applications. We explain how to perform authentication, retrieve resources, create and update data, as well as best practices for using the API securely and efficiently.

**Let's Get Started!** 

Whether you're developing a mobile app, building a website, or pursuing another creative use case, our REST API is designed to support your projects. Let's collaborate to create fantastic applications that enhance the way people connect with each other.

Let's get started and explore the Becard REST API documentation. If you have any questions or concerns, our support team is available at <developer@becard.me>.


---

# 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.becard.me/rest-api/introduction.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.