Get started

Create an API key in the frontend and submit your first job from `curl` or GitHub Actions.

1) Create an API key in the frontend

Use the button below to generate a key. The key is only shown once, so copy it immediately.

Generate a key.
Store it in your password manager or CI secrets.
Use it as `Authorization: ApiKey ...` in API calls.

API key

Generate a key to replace placeholder values in the examples.

2) Submit your first job with curl

YAML payload mode

curl -X POST http://127.0.0.1:4174/api/jobs/submit \
  -H "Authorization: ApiKey <api key>" \
  -H "Content-Type: application/json" \
  -d "$(jq -n --rawfile def pipeline.yaml '{definition: $def, name: "my-job", ref: "main"}')"

Replace `pipeline.yaml` with your own pipeline file. This example requires `jq`.

Repository archive mode

tar -czf repo.tar.gz . && \
curl -X POST http://127.0.0.1:4174/api/jobs/submit \
  -H "Authorization: ApiKey <api key>" \
  -F "[email protected];type=application/gzip" \
  -F "embeddedci_yaml=pipeline.yaml"

3) Run from GitHub Actions

name: EmbeddedCI
on: [push]

jobs:
  submit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Submit job to EmbeddedCI
        uses: embeddedci-com/submit-job-action@main
        with:
          api_url: ${{ secrets.EMBEDDEDCI_API_URL }}
          api_key: ${{ secrets.EMBEDDEDCI_API_KEY }}
          source_path: pipeline.yaml
          archive_directory: .

Save `EMBEDDEDCI_API_URL` and `EMBEDDEDCI_API_KEY` as repository secrets.