Ir al contenido
Matrix TimeCard
ENESP
Obtén la app

Desarrolladores

Use with AI agents

La documentación de la API solo está en inglés.

Documentación de la API: Use with AI agents

An AI agent can call the Matrix TimeCard API for you. Give it the Matrix TimeCard skill file. The skill tells the agent how to authenticate, which rules to follow and how to do the common tasks safely.

Back to the index

The skill file

The skill is one Markdown file in the Agent Skills format. Its name is matrix-timecard-api. It holds:

  • the base URL form and the API key rules;
  • the rules that the agent must follow, for example safe updates, paging and retries;
  • one curl recipe for each common task;
  • the error codes and what to do for each one;
  • links to the full reference.

The skill is on this site at /docs/skill/SKILL.md. It is plain Markdown. It holds no API key and no account data.

Raw Markdown for agents

Each page of these docs is also available as plain Markdown. Add .md to the page address, for example /docs/getting-started.md or /docs/reference/activities.md. The overview is /docs/README.md.

/llms.txt lists the skill and every Markdown page, with one line on each. It follows the llms.txt convention.

Install the skill

The skill file is at https://matrixtimecard.com/docs/skill/SKILL.md.

Claude Code

Run one of these commands in a terminal, then start a new Claude Code session.

For every project on your computer:

mkdir -p ~/.claude/skills/matrix-timecard-api && \
  curl -fsSL https://matrixtimecard.com/docs/skill/SKILL.md \
  -o ~/.claude/skills/matrix-timecard-api/SKILL.md

For one project only (run it in the project folder, and commit the file to share it with your team):

mkdir -p .claude/skills/matrix-timecard-api && \
  curl -fsSL https://matrixtimecard.com/docs/skill/SKILL.md \
  -o .claude/skills/matrix-timecard-api/SKILL.md

Claude Code loads the skill when a task needs the Matrix TimeCard API. To check, ask Claude Code "What skills do you have?" and look for matrix-timecard-api.

To update the skill, run the same command again.

Claude apps (claude.ai and Claude Desktop)

  1. Download the skill file:

    mkdir -p matrix-timecard-api && \
  curl -fsSL https://matrixtimecard.com/docs/skill/SKILL.md -o matrix-timecard-api/SKILL.md && \
  zip -r matrix-timecard-api.zip matrix-timecard-api

  2. Open Settings → Capabilities → Skills and upload matrix-timecard-api.zip.

  3. Turn the skill on.

The zip must hold the matrix-timecard-api folder with SKILL.md inside it.

Other agents

Give the agent the address of the skill file, https://matrixtimecard.com/docs/skill/SKILL.md, or of the index, https://matrixtimecard.com/llms.txt. Tell the agent to read it before it calls the API. An agent that supports the Agent Skills format can save the file as a skill: put SKILL.md in a folder named matrix-timecard-api in the agent's skills folder.

Keep your data safe

  1. Give the agent a key with the fewest scopes that it needs. For example, a key that only reads Jobs needs only activity:read. See Authentication.
  2. Use a test account first. A tc_test_ key writes live data. Ask your administrator for a test account.
  3. Keep the key in an environment variable, for example TIMECARD_API_KEY. Do not paste the key into a chat, a prompt or a file that you share.
  4. Check bulk changes before they run. The skill tells the agent to send a dry run first and to ask you before it closes Jobs, deactivates equipment or runs an import. Read the dry-run result before you agree.
  5. Revoke the key when the agent no longer needs it. See Authentication.