DataTap

DATATAP / Create a profile

Create a profile

One JSON file. Your own form.

Create a profile with your AI

Paste the prompt into your AI assistant with a cURL command, a Swagger/OpenAPI definition, a Postman collection, or a description of your API. Remove real credentials and sensitive data before sharing your material.

View full prompt

1. Choose an example

Examples use a placeholder API. Replace its URL with your own HTTPS endpoint before sending.

2. Define the destination and fields

Save the file as UTF-8 text with a .datatap extension. label is shown to the person; key is sent to your API.

{
  "version": 1,
  "name": "Quick record",
  "request": {
    "url": "https://api.example.com/records",
    "method": "POST",
    "auth": {
      "type": "none"
    },
    "encoding": "json",
    "emptyFields": "omit"
  },
  "inputs": [
    {
      "key": "code",
      "type": "text",
      "label": "Code",
      "required": true
    },
    {
      "key": "quantity",
      "type": "number",
      "label": "Quantity",
      "required": true
    }
  ],
  "response": {
    "type": "none"
  }
}

The profile contract

PropertyWhat to configure
versionAlways 1.
nameInitial profile name. Each import creates a new copy that can be renamed or deleted.
request.urlAbsolute HTTPS URL of your API. Supports fixed query parameters and dynamic segments such as {productId}. Redirects are not followed.
request.method / encodingPOST, PUT, or PATCH with json or multipart. GET requires query and cannot include images. On iOS, GET endpoints must support HTTP/1.1.
request.emptyFieldsomit skips empty optional fields. null sends JSON null, or the literal text null in multipart/query.
inputsNonempty flat list. Each field has key, type, label, and boolean required. Keys must be unique and match ^[A-Za-z_][A-Za-z0-9_]*$. Nested objects are not supported.
responseUse exactly {"type":"none"}. HTTP 2xx confirms submission and clears the form; the response body is ignored. Errors preserve the entered values.

Types and arrays

text, number, date, boolean, enum, image.

Append [] to allow multiple values, such as image[] or date[]. JSON uses an array; multipart and query repeat the same key, without a [] suffix. Zero and false are present values, not empty fields. Required fields are checked when sending.

QR codes and barcodes populate text fields without opening scanned URLs. Dates are sent as YYYY-MM-DD, without a time or timezone. JSON numbers use a decimal point and booleans use true/false.

Fixed choices

The enum and enum[] types require options with a visible label and a value sent to the API. Values within a field must all be nonempty strings or all finite numbers, without duplicates. Options are never downloaded from a server.

{
  "key": "priority",
  "type": "enum",
  "label": "Priority",
  "required": true,
  "options": [
    {
      "label": "Normal",
      "value": 1
    },
    {
      "label": "High",
      "value": 2
    }
  ]
}

Authentication

Without authentication: {"type":"none"}. For API key authentication, use the following object. Never include the real key in the file: each person enters their own when importing. It is stored in Keychain (iOS) or encrypted using Android Keystore.

{"type":"apiKey","in":"header","name":"X-API-Key"}

in: "query" is also supported if your API requires it. For a Bearer token, use {"type":"bearer"}. The app adds the Authorization header.

Destinations, validation, and UUIDs

These options require DataTap 0.2.0 or later. The file still uses "version": 1.

  • Each field can include a destination with in set to path, query, header, or body. name defaults to key. If destination is omitted, the encoding determines the destination.
  • Each path parameter occupies a whole segment and requires a scalar input. The query supports lists and can accompany a body. Headers accept printable ASCII scalar values and are omitted when empty. DataTap checks for destination collisions and reserved headers.
  • Use integer, min, and max for numbers, and minLength and maxLength for text. Bounds are inclusive and apply per item. To require text with content, combine required: true with minLength: 1.
  • The optional request.generated list can send a UUID in a header or the body. Each manual submission generates new keys and can produce another operation.
{
  "generated": [
    {
      "type": "uuid",
      "destination": {
        "in": "header",
        "name": "Idempotency-Key"
      }
    }
  ]
}

Photos and request size

If there are image fields, add images at the root. Images come from the camera or gallery. Multipart sends files; JSON sends Base64 without a data URL prefix. Images are processed locally to JPEG at 90% quality.

{"images":{"resize":{"mode":"fit","maxWidth":1280,"maxHeight":1280}}}

Resizing preserves aspect ratio and does not enlarge small images. To preserve dimensions, use {"resize":{"mode":"original"}}. Fit bounds must be integers from 1 to 8192 px. Requests are limited to 20 MiB including Base64/multipart overhead; profiles are limited to 1 MiB.

3. Share and import

Share the file or host it at a direct HTTPS URL. You can encode that URL in a QR code for camera import; for smaller profiles, you can also use the compact JSON as literal text. The recommended MIME type is application/vnd.datatap. In DataTap: Import profile → file, URL, or QR.

Always review the destination before importing. Test with fictional data. There are no drafts after closing or automatic retries: if the connection fails after your API receives a record, check the server before resubmitting.