rename to api and include status progress (#36)

* rename to api and include status progress

* fix errors

Author: splch

api/README.md

@@ -0,0 +1,43 @@
+# API
+
+[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ionq-samples/getting-started/blob/main/curl/main.ipynb)
+
+---
+
+Get your API key from <https://cloud.ionq.com/settings/keys>.
+
+## Submit a Job:
+
+```shell
+curl -X POST "https://api.ionq.co/v0.3/jobs" \
+  -A "curl/$(curl --version | awk 'NR==1 {print $2}')" \
+  -H "Authorization: apiKey $IONQ_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d @data.json
+```
+
+> {"id":"7cc8ce51-2e57-4140-96ce-cf8bada0bf91","status":"ready","request":1691469978}
+
+Use `id` to query the job.
+
+## Query a Job:
+
+```shell
+curl "https://api.ionq.co/v0.3/jobs/7cc8ce51-2e57-4140-96ce-cf8bada0bf91" \
+  -H "Authorization: apiKey $IONQ_API_KEY"
+```
+
+> {"noise":{"model":"ideal"},"status":"submitted","children":[],"target":"simulator","id":"7cc8ce51-2e57-4140-96ce-cf8bada0bf91","request":1691469978}
+
+> {"noise":{"model":"ideal"},"status":"completed","children":[],"target":"simulator","predicted_execution_time":4,"execution_time":26,"id":"7cc8ce51-2e57-4140-96ce-cf8bada0bf91","qubits":2,"request":1691469978,"start":1691469979,"response":1691469979,"gate_counts":{"1q":1,"2q":1},"results_url":"/v0.3/jobs/7cc8ce51-2e57-4140-96ce-cf8bada0bf91/results"}
+
+When `status` becomes `completed`, get the job results.
+
+## Get Job Results:
+
+```shell
+curl "https://api.ionq.co/v0.3/jobs/7cc8ce51-2e57-4140-96ce-cf8bada0bf91/results" \
+  -H "Authorization: apiKey $IONQ_API_KEY"
+```
+
+> {"0":0.500000000,"3":0.500000000}